tencent cloud

Tencent Cloud Organization

  • Product Introduction
  • Purchase Guide
  • Operation Guide
    • Console Overview
    • Organization Settings
    • Department Management
    • Member Account Management
    • Member Finance Management
    • Member Access Management
    • Resource Management
    • Member Audit
    • Identity Center Management
  • API Documentation
    • History
    • Introduction
    • API Category
    • Making API Requests
    • Organization Settings APIs
    • Department and Member Management APIs
    • ListOrganizationIdentity
    • Unified Member Login APIs
    • Organization Service Management APIs
    • Organization Management Policy APIs
    • Resource Sharing APIs
    • Identity Center Management APIs
    • Identity Center User Management APIs
    • Identity Center User Group Management APIs
    • Identity Center Management SCIM Synchronization APIs
    • Identity Center Single Sign-On Management APIs
    • Identity Center Permission Configuration Management APIs
    • Identity Center Multi-Account Authorization Management APIs
    • Identity Center Sub-User Synchronization Management APIs
    • Data Types
    • Error Codes
    • TCO API 2018-12-25
  • Related Agreement
  • FAQs
  • Glossary

CreateRoleConfiguration

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2026-03-20 00:29:08

1. API Description

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

This API is used to create permission configurations.

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: CreateRoleConfiguration.
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.
RoleConfigurationName Yes String Permission configuration name, which contains up to 128 characters, including English letters, digits, and hyphens (-).
Description No String Permission configuration description, which contains up to 1,024 characters.
SessionDuration No Integer Session duration, in seconds. It is the maximum time a CIC user can maintain a session while using permission configurations to access a target account in TCO. Value range: 900 to 43200 (15 minutes to 12 hours). Default: 3600 (1 hour).
RelayState No String Initial access page. It is the initial page address when a CIC user uses permission configurations to access a target account in TCO. This page must be a Tencent Cloud console page. The default value is empty, representing a redirection to the home page of the Tencent Cloud console.

3. Output Parameters

Parameter Name Type Description
RoleConfigurationInfo RoleConfiguration Access configuration 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 Creating Permission Configurations

This example shows you how to create permission configurations.

Input Example

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

{
    "ZoneId": "z-33923n",
    "RoleConfigurationName": "conf1",
    "Description": "this is role configuration",
    "SessionDuration": 900,
    "RelayState": "https://console.tencentcloud.com"
}

Output Example

{
    "Response": {
        "RoleConfigurationInfo": {
            "RoleConfigurationId": "rc-s2ns92ns***",
            "RoleConfigurationName": "conf1",
            "Description": "this is role configuration",
            "SessionDuration": 900,
            "RelayState": "https://console.tencentcloud.com",
            "CreateTime": "2019-01-01 12:12:12",
            "UpdateTime": "2019-01-01 12:12:12"
        },
        "RequestId": "e297543a-80de-4039-83c8-9d324545"
    }
}

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.ConfigurationOverUpperLimit Permission configurations created for a directory exceed the upper limit.
FailedOperation.DBOperationError SQL execution error.
FailedOperation.IdentityCenterNotOpen The CIC service is not enabled.
FailedOperation.ZoneIdNotExist The user zoneId of the CIC service does not exist.
InvalidParameter.ConfigurationNameAlreadyExists The permission configuration name already exists.
InvalidParameter.ConfigurationNameFormatError The permission configuration name has a format error.

Ajuda e Suporte

Esta página foi útil?

comentários