POST Update Role endpoint.
Endpoint
POST
/web/v1/partner/roles/update WEBAuthentication
- Chain: WEB
- JWT Token: true
- API Key: false
- Permissions: ["workspace:role:write"]
- Secure Channel: DISABLED
Rate Limit
120 requests per 60 seconds.
Headers
Frontend Headers
| Header | Required | Description |
|---|---|---|
| X-LOCALE | Yes | 用户的 locale |
| Accept-Language | No | 语言偏好 |
Cloudflare Headers
| Header | Required | Description |
|---|---|---|
| CF-Connecting-IP | Yes | Client IP from Cloudflare |
| CF-IPCountry | Yes | Client country code |
| CF-Ray | Yes | Cloudflare Ray ID |
| CF-Visitor | Yes | Visitor scheme |
| X-Real-IP | Yes | Real client IP |
Nginx Headers
| Header | Required | Description |
|---|---|---|
| X-PORTAL-ACCESS-CODE | Yes | Portal access code |
| X-Real-IP | Yes | 客户端真实 IP |
| X-Forwarded-For | Yes | 代理链 |
| X-Forwarded-Proto | Yes | 协议 |
Request Parameters
Body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
| roleId | String | Yes | Role business ID |
| roleName | String | No | Role name (max 126) |
| description | String | No | Description (max 255) |
Response
200 OK
| Field | Type | Description |
|---|---|---|
| bizId | String | Business ID |
| workspaceBizId | String | Workspace business ID |
| roleName | String | Role name |
| roleType | WorkspaceRoleType | Role type |
| description | String | Description |
| permissionCodes | List<String> | Permission codes |
| createdAt | Instant | Creation time |
| updatedAt | Instant | Update time |