All Products
Search
Document Center

Resource Access Management:CreateRole

Last Updated:Jun 02, 2023

Creates a RAM role.

Operation Description

For more information about RAM roles, see Overview of RAM roles.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ram:CreateRoleWrite
  • RAM
    acs:ram:*:{#accountId}:role/{#RoleName}
  • ram:TrustedPrincipalTypes
  • ram:ServiceNames
none

Request parameters

ParameterTypeRequiredDescriptionExample
RoleNamestringYes

The name of the RAM role.

The name must be 1 to 64 characters in length, and can contain letters, digits, periods (.), and hyphens (-).

ECSAdmin
DescriptionstringNo

The description of the RAM role.

The description must be 1 to 1,024 characters in length.

AssumeRolePolicyDocumentstringYes

The trust policy that specifies one or more trusted entities to assume the RAM role. The trusted entities can be Alibaba Cloud accounts, Alibaba Cloud services, or identity providers (IdPs).

NoteRAM users cannot assume the RAM roles of trusted Alibaba Cloud services.
{"Statement":[{"Action":"sts:AssumeRole","Effect":"Allow","Principal":{"RAM":"acs:ram::123456789012****:root"}}],"Version":"1"}
MaxSessionDurationlongNo

The maximum session duration of the RAM role.

Valid values: 3600 to 43200. Unit: seconds. Default value: 3600.

If you do not specify this parameter, the default value is used.

3600

The following content provides sample values for the AssumeRolePolicyDocument parameter.

  • The following policy allows the RAM role to be assumed by all RAM users of the Alibaba Cloud account whose ID is 123456789012****.

    
    {
    	"Statement": [{
    		"Action": "sts:AssumeRole",
    		"Effect": "Allow",
    		"Principal": {
    			"RAM": [
    				"acs:ram::123456789012****:root"
    			]
    		}
    	}],
    	"Version": "1"
    }
  • The following policy allows the RAM role to be assumed by the RAM user named testuser of the trusted Alibaba Cloud account whose ID is 123456789012****.

NoteBefore you create the role, ensure that you have created a RAM user named testuser whose logon name is testuser@123456789012****.onaliyun.com.
```

{
	"Statement": [{
		"Action": "sts:AssumeRole",
		"Effect": "Allow",
		"Principal": {
			"RAM": [
				"acs:ram::123456789012****:user/testuser"
			]
		}
	}],
	"Version": "1"
}
```
  • The following policy allows the RAM role to be assumed by the Elastic Compute Service (ECS) service of the current trusted Alibaba Cloud account.

    
    {
    	"Statement": [{
    		"Action": "sts:AssumeRole",
    		"Effect": "Allow",
    		"Principal": {
    			"Service": [
    				"ecs.aliyuncs.com"
    			]
    		}
    	}],
    	"Version": "1"
    }
  • The following policy allows the RAM role to be assumed by the Security Assertion Markup Language (SAML) IdP named testprovider of the current trusted Alibaba Cloud account whose ID is 123456789012****.

NoteBefore you create the role, ensure that you have created a SAML IdP named testprovider.
```

{
	"Statement": [{
		"Action": "sts:AssumeRole",
		"Effect": "Allow",
		"Principal": {
			"Federated": [
				"acs:ram::123456789012****:saml-provider/testprovider"
			]
		},
		"Condition": {
			"StringEquals": {
				"saml:recipient": "https://signin.aliyun.com/saml-role/sso"
			}
		}
	}],
	"Version": "1"
}
```
  • The following policy allows the RAM role to be assumed by the OIDC IdP named TestOIDCProvider of the current trusted Alibaba Cloud account whose ID is 123456789012****.
NoteBefore you create the policy, ensure that you have created an OIDC IdP named TestOIDCProvider.
```

{
	"Statement": [{
		"Action": "sts:AssumeRole",
		"Effect": "Allow",
		"Principal": {
			"Federated": [
				"acs:ram::123456789012****:oidc-provider/TestOIDCProvider"
			]
		},
		"Condition": {
			"StringEquals": {
				"oidc:aud": [
					"496271242565057****"
				],
				"oidc:iss": "https://dev-xxxxxx.okta.com",
				"oidc:sub": "KryrkIdjylZb7agUgCEf****"
			}
		}
	}],
	"Version": "1"
}
```

Response parameters

ParameterTypeDescriptionExample
object
Roleobject

The information of the RAM role.

AssumeRolePolicyDocumentstring

The trust policy that specifies the trusted entity to assume the RAM role.

{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }
Descriptionstring

The description of the RAM role.

MaxSessionDurationlong

The maximum session duration of the RAM role.

3600
RoleNamestring

The name of the RAM role.

ECSAdmin
CreateDatestring

The time when the RAM user was created.

2015-01-23T12:33:18Z
RoleIdstring

The ID of the RAM role.

901234567890****
Arnstring

The Alibaba Cloud Resource Name (ARN) of the role.

acs:ram::123456789012****:role/ECSAdmin
RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Sample success responses

JSONformat

{
  "Role": {
    "AssumeRolePolicyDocument": "{ \"Statement\": [ { \"Action\": \"sts:AssumeRole\", \"Effect\": \"Allow\", \"Principal\": { \"RAM\": \"acs:ram::123456789012****:root\" } } ], \"Version\": \"1\" }",
    "Description": "",
    "MaxSessionDuration": 3600,
    "RoleName": "ECSAdmin",
    "CreateDate": "2015-01-23T12:33:18Z",
    "RoleId": "901234567890****",
    "Arn": "acs:ram::123456789012****:role/ECSAdmin"
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

For a list of error codes, visit the Service error codes.