CreateRole

Last updated: 2020-09-17 17:56:35

1. API Description

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

This API (CreateRole) is used to create a role.

A maximum of 3 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 parameter. The value used for this API: CreateRole.
Version Yes String Common parameter. The value used for this API: 2019-01-16.
Region No String Common parameter. This parameter is not required for this API.
RoleName Yes String Role name
PolicyDocument Yes String Policy document
Description No String Role description
ConsoleLogin No Integer Whether login is allowed. 1: yes, 0: no
SessionDuration No Integer The maximum validity period of the temporary key for creating a role (range: 0-43200)

3. Output Parameters

Parameter Name Type Description
RoleId String Role ID
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a role

Input Example

https://cam.tencentcloudapi.com/?Action=CreateRole
&RoleName=test_1234544
&PolicyDocument=%7B%22version%22%3A%222.0%22%2C%22statement%22%3A%5B%7B%22action%22%3A%22name%2Fsts%3AAssumeRole%22%2C%22effect%22%3A%22allow%22%2C%22principal%22%3A%7B%22service%22%3A%5B%22cloudaudit.cloud.tencent.com%22%2C%22cls.cloud.tencent.com%22%5D%7D%7D%5D%7D
&Description=abc
&<Common request parameter>

Output Example

{
  "Response": {
    "RoleId": 123456789,
    "RequestId": "0bac591a-6cc7-4e9d-8d01-74618f1a9611"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InternalError.SystemError Internal error.
InvalidParameter.ActionError Action field of policy document invalid.
InvalidParameter.ActionMiss The action in the policy syntax does not exist.
InvalidParameter.AttachmentFull Limit on number of authorization object associated policies in the principal field reached.
InvalidParameter.ConditionError condition field of policy document invalid.
InvalidParameter.DescriptionLengthOverlimit The input parameter description cannot exceed 300 bytes in length.
InvalidParameter.EffectError Effect field of policy document invalid.
InvalidParameter.ParamError Invalid input parameter.
InvalidParameter.PrincipalError principal field of policy document invalid.
InvalidParameter.PrincipalQcsError Incorrect PrincipalQcsc.
InvalidParameter.PrincipalQcsNotExist PrincipalQcs does not exist.
InvalidParameter.PrincipalServiceNotExist PrincipalService does not exist.
InvalidParameter.RoleFull Limit on number of roles reached.
InvalidParameter.RoleNameError Role name invalid.
InvalidParameter.RoleNameInUse A role with the same name already exists.
InvalidParameter.StatementError Statement field of policy document invalid.
InvalidParameter.UserNotExist User object does not exist
InvalidParameter.VersionError Version field of policy document invalid.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help