tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DeleteRoleAssignment

Last updated: 2024-08-26 11:25:51

1. API Description

Domain name for API request: organization.tencentcloudapi.com.

This API is used to remove authorizations on member accounts.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DeleteRoleAssignment.
Version Yes String Common Params. The value used for this API: 2021-03-31.
Region No String Common Params. This parameter is not required.
ZoneId Yes String Space ID.
RoleConfigurationId Yes String Permission configuration ID.
TargetType Yes String Type of the synchronized target account of the Tencent Cloud Organization. ManagerUin: admin account; MemberUin: member account.
TargetUin Yes Integer UIN of the target account of the Tencent Cloud Organization.
PrincipalType Yes String Identity type for the CAM user synchronization. Valid values: User: indicates that the identity for the CAM user synchronization is a CIC user; Group: indicates that the identity for the CAM user synchronization is a CIC user group.
PrincipalId Yes String Identity ID for the CAM user synchronization. Valid values: When the PrincipalType value is Group, it is the CIC user group ID (g-). When the PrincipalType value is User, it is the CIC user ID (u-).
DeprovisionStrategy No String Whether to undeploy an access configuration synchronously when you remove the last authorization for using this access configuration on the target account of the Tencent Cloud Organization. Valid values: DeprovisionForLastRoleAssignmentOnAccount: Undeploy the access configuration; None (default): Do not undeploy access configuration.

3. Output Parameters

Parameter Name Type Description
Task TaskInfo Task details.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Removing Authorizations on Member Accounts

This example shows you how to remove authorizations on member accounts.

Input Example

POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteRoleAssignment
<Common request parameters>

{
    "ZoneId": "z-2ms923mw",
    "RoleConfigurationId": "rc-smw9em32",
    "TargetType": "MemberUin",
    "TargetUin": 10000332,
    "PrincipalType": "User",
    "PrincipalId": "u-siwnwiene",
    "DeprovisionStrategy": "DeprovisionForLastRoleAssignmentOnAccount"
}

Output Example

{
    "Response": {
        "Task": {
            "TaskId": "t-0md93jfd3",
            "RoleConfigurationId": "rc-dsk3323",
            "RoleConfigurationName": "test",
            "TargetUin": 100032333,
            "TargetType": "MemberUin",
            "PrincipalId": "u-siwnwiene",
            "PrincipalType": "User",
            "TaskType": "DeleteRolesAssignment",
            "Status": "InProgress"
        },
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.IdentityCenterNotOpen The CIC service is not enabled.
FailedOperation.ZoneIdNotExist The user zoneId of the CIC service does not exist.
ResourceNotFound.RoleConfigurationAuthorizationNotFound The permission authorization record does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy