Create a RAM role with CreateRole - Resource Access Management - Alibaba Cloud - Resource Access Management

Operation description

For more information about RAM roles, see RAM role overview.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ram:CreateRole

create

*Role

acs:ram:*:{#accountId}:role/{#RoleName}

ram:TrustedPrincipalTypes
ram:ServiceNames

None

Request parameters

Parameter	Type	Required	Description	Example
RoleName	string	No	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
Description	string	No	The description of the RAM role. The description must be 1 to 1024 characters in length.	ECS management role.
AssumeRolePolicyDocument	string	No	The trust policy. Specifies one or more principals that are allowed to assume the RAM role. The principal can be an Alibaba Cloud account, an Alibaba Cloud service, or an identity provider. Note Resource Access Management (RAM) users cannot assume RAM roles whose trusted entity is an Alibaba Cloud service.	{"Statement":[{"Action":"sts:AssumeRole","Effect":"Allow","Principal":{"RAM":"acs:ram::123456789012****:root"}}],"Version":"1"}
MaxSessionDuration	integer	No	The maximum session duration of the RAM role. Valid values: 3600 to 43200. Unit: seconds. Default value: 3600. If you leave this parameter empty, the default value is used.	3600
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key.	k1
Value	string	No	The tag value.	v1
AllowConsoleLogin	boolean	No	Specifies whether console logon is allowed for the RAM role. Valid values: true: Console logon is allowed. false: Console logon is not allowed.	true

AssumeRolePolicyDocument examples

The following policy indicates that the trusted entity allowed to assume the RAM role is any authorized Resource Access Management (RAM) user under the Alibaba Cloud account (AccountID=123456789012****).

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

The following policy indicates that the trusted entity allowed to assume the RAM role is the RAM user testuser under the Alibaba Cloud account (AccountID=123456789012****).

Note

Before creating this role, make sure that the RAM user testuser has been created (logon name: testuser@123456789012****.onaliyun.com).

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

The following policy indicates that the trusted entity allowed to assume the RAM role is the ECS service under the current Alibaba Cloud account.

{
	"Statement": [{
		"Action": "sts:AssumeRole",
		"Effect": "Allow",
		"Principal": {
			"Service": [
				"ecs.aliyuncs.com"
			]
		}
	}],
	"Version": "1"
}

The following policy indicates that the trusted entity allowed to assume the RAM role is the SAML identity provider testprovider under the current Alibaba Cloud account (AccountID=123456789012****).

Note

Before creating this role, make sure that the SAML identity provider testprovider has been created.

{
	"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 indicates that the trusted entity allowed to assume the RAM role is the OIDC identity provider TestOIDCProvider under the current Alibaba Cloud account (AccountID=123456789012****).

Note

Before creating this role, make sure that the OIDC identity provider TestOIDCProvider has been created.

{
	"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 elements

Element	Type	Description	Example
	object	The response parameters.
Role	object	The information about the RAM role.
AssumeRolePolicyDocument	string	The trust policy of the RAM role.	{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }
Description	string	The description of the RAM role.	ECS management role.
MaxSessionDuration	integer	The maximum session duration of the RAM role.	3600
RoleName	string	The name of the RAM role.	ECSAdmin
CreateDate	string	The time when the RAM role was created.	2015-01-23T12:33:18Z
RoleId	string	The ID of the RAM role.	901234567890****
Arn	string	The resource descriptor of the RAM role.	acs:ram::123456789012****:role/ECSAdmin
AllowConsoleLogin	boolean	Indicates whether console logon is allowed for the RAM role.	true
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.