绑定员工角色
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateIntegrationUserRoles。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
UserIds.N | 是 | Array of String | 绑定角色的用户id列表,不能重复,不能大于 100 个 |
RoleIds.N | 是 | Array of String | 绑定角色的角色id列表,不能重复,不能大于 100,可以通过DescribeIntegrationRoles接口获取角色信息 |
Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FailedCreateRoleData | Array of FailedCreateRoleData | 绑定角色失败列表信息 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例-主代子绑定角色
示例-主代子绑定角色
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntegrationUserRoles
<公共请求参数>
{
"Agent": {
"ProxyOrganizationId": "yDwcwUUg*****b2eQRA5tb3wCvJ"
},
"UserIds": [
"yDwcwUUgyg3****2eQS1BsaTeVDP"
],
"RoleIds": [
"6fad1903****6921046819037"
],
"Operator": {
"UserId": "yDwnHUU****MR3gQvehewF4C5"
}
}
输出示例
{
"Response": {
"FailedCreateRoleData": [],
"RequestId": "s1679*****21175"
}
}
示例2 示例-普通企业绑定角色
示例-普通企业绑定角色
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIntegrationUserRoles
<公共请求参数>
{
"UserIds": [
"y**************************************************s",
"y**************************************************e"
],
"RoleIds": [
"0************************************************e",
"f*************************************************b"
],
"Operator": {
"UserId": "y**********************************s"
}
}
输出示例
{
"Response": {
"FailedCreateRoleData": [
{
"RoleIds": [
"**************************************************",
"**************************************************"
],
"UserId": "*******************************************"
}
],
"RequestId": "s******************"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError.System | 系统错误,请稍后重试。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.NoPermissionUseResource | 无权限使用文件资源,请检查资源有效性以及资源归属,并在修改后重试。 |
ResourceNotFound.User | 用户或者员工信息不存在,请检查参数后重试。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |