tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ProvisionRoleConfiguration

Last updated: 2024-11-27 21:24:59

1. API Description

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

This API is used to deploy permission configurations 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: ProvisionRoleConfiguration.
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.

3. Output Parameters

Parameter Name Type Description
Task RoleProvisioningsTask 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 Deploying Permission Configurations to Member Accounts

This example shows you how to deploy permission configurations to member accounts.

Input Example

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

{
    "ZoneId": "z-disndw****",
    "RoleConfigurationId": "rc-sians9wn****",
    "TargetType": "MemberUin",
    "TargetUin": 10000293120
}

Output Example

{
    "Response": {
        "RequestId": "d95c7cc0-195d-4818-aa3a-e7dc73eafe37",
        "Task": {
            "RoleConfigurationId": "rc-4plmus8fdfsb",
            "RoleConfigurationName": "testConfiguration1",
            "TargetType": "MemberUin",
            "TargetUin": 700000145543,
            "TaskId": "t-2xdmzwphpsbd",
            "TaskStatus": "InProgress",
            "TaskType": "CreateRoleAssignment"
        }
    }
}

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.OrganizationMemberNotExist The member account does not exist.
FailedOperation.UserOverUpperLimit Users created exceed the upper limit.
FailedOperation.ZoneIdNotExist The user zoneId of the CIC service does not exist.
InvalidParameter.EmailAlreadyExists The email address already exists.
InvalidParameter.UsernameAlreadyExists The username already exists.
InvalidParameter.UsernameFormatError The username has a format error.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy