Assume Role
GET {{aws_security_token_service_aws_sts_base_url}}/?DurationSeconds&ExternalId&Policy&PolicyArns.member.N&RoleArn&RoleSessionName&SerialNumber&Tags.member.N&TokenCode&TransitiveTagKeys.member.N&Version=2011-06-15
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
DurationSeconds | null | The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. | |
ExternalId | null | A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the ExternalId parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide. | |
Policy | null | An IAM policy in JSON format that you want to use as an inline session policy. | |
PolicyArns.member.N | null | The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role. | |
RoleArn | null | The Amazon Resource Name (ARN) of the role to assume. | |
RoleSessionName | null | An identifier for the assumed role session. | |
SerialNumber | null | The identification number of the MFA device that is associated with the user who is making the AssumeRole call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). | |
Tags.member.N | null | A list of session tags that you want to pass. Each session tag consists of a key name and an associated value. For more information about session tags, see Tagging AWS STS Sessions in the IAM User Guide. | |
TokenCode | null | The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or expired, the AssumeRole call returns an access denied error. | |
TransitiveTagKeys.member.N | null | A list of keys for session tags that you want to set as transitive. If you set a tag key as transitive, the corresponding key and value passes to subsequent sessions in a role chain. For more information, see Chaining Roles with Session Tags in the IAM User Guide. | |
Version | string | The version of the API. |