Assign User Roles¶
给用户分配角色。
调用此 API 更新用户角色时,将覆盖用户的已有角色,如有需要,可先使用 Get User Roles API 查询用户的已有角色。
前提条件¶
应用需拥有“在本 OU 给用户授权”的权限。如有需要,联系 OU 管理员获取权限。
请求格式¶
POST https://{apigw-address}/app-portal-service/v2.2/role/appendRoles
请求参数(Body)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
organizationId |
必需 |
String |
|
userId |
必需 |
String |
用户 ID。如何获取 userId 信息 >> |
roleIds |
必需 |
List |
需要给用户分配的角色 ID。指定的所有角色将分配给用户。若用户已有角色,且不在本次指定范围内,已有角色将被覆盖。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
data |
Boolean |
角色是否分配成功。 |
错误码¶
代码 |
描述 |
---|---|
31400 |
参数错误,长度错误,不能为空等。 |
31403 |
应用未被授予“在本 OU 给用户授权”的权限。 |
31404 |
未找到 OU。 |
示例¶
请求示例¶
url: https://{apigw-address}/app-portal-service/v2.2/role/appendRoles
method: POST
requestBody:
{"organizationId":"yourOrgId", "userId":"yourUserId","roleIds": ["role1","role2","role3"]}
返回示例¶
{
"code": 0,
"message": "OK",
"data": true
}