POST/api/v1/orgs/:orgId/members/:userId/roles为成员授予组织角色
Try it 面板需要启用 JavaScript。
向组织成员授予一个组织角色;需要组织管理权限。
Request
| Name | Data Type | Required | Description |
| Authorization | string | Yes | 会话令牌认证,格式 `Bearer <sessionToken>` |
| Content-Type | string | Yes | 请求体内容类型(默认值 "application/json") |
type RequestHeaders = {
/** 会话令牌认证,格式 `Bearer <sessionToken>` */
Authorization: string
/** 请求体内容类型,默认值 "application/json" */
Content-Type: string
}
{
"Authorization": "Bearer st_7c1f9e05b28d4a63",
"Content-Type": "application/json"
}
URL Parameters
| Name |
Data Type |
Description |
| orgId |
string |
组织 ID |
| userId |
string |
成员用户 ID |
Body
| Name | Data Type | Required | Description |
| roleId | string | Yes | 要授予的角色 ID |
type RequestBody = {
/** 要授予的角色 ID */
roleId: string
}
{
"roleId": "01JD8SRR3N6V0X8ZS7X1ZFN4A9M"
}
Response
Body
result type: null
HTTP Code
| HTTP Status |
Meaning |
Notes |
| 200 |
成功 |
角色已授予 |
| 403 |
无权操作 |
需要组织管理权限 |
Response Code
响应使用统一信封 {id, code, messages, result},其 code 字段:
| code |
Meaning |
Notes |
| 0 |
成功 |
角色已授予 |
| 2501 |
无权操作组织 |
当前用户不持有组织管理权限 |
| 2505 |
成员不存在 |
该用户不属于此组织 |
| 2605 |
已持有该角色 |
该成员已持有此角色 |
Examples
POST /api/v1/orgs/01JD8SRP1N4T8W6XQ5V9XDL2Y7K/members/01JD8SRQ2N5U9W7YR6W0YEM3Z8L/roles
Authorization: Bearer st_7c1f9e05b28d4a63
Content-Type: application/json
{
"roleId": "01JD8SRR3N6V0X8ZS7X1ZFN4A9M"
}
{
"id": "01JD8SSFVA4V2XQ",
"code": 0,
"messages": [],
"result": null
}