AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Returns a set of temporary security credentials for users who have been authenticated
via a SAML authentication response. This operation provides a mechanism for tying
an enterprise identity store or directory to role-based AWS access without user-specific
credentials or configuration. For a comparison of
with the other APIs that produce temporary credentials, see Requesting
Temporary Security Credentials and Comparing
the AWS STS APIs in the IAM User Guide.
The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services.
By default, the temporary security credentials created by
last for one hour. However, you can use the optional
parameter to specify the duration of your session. Your role session lasts for the
duration that you specify, or until the time specified in the SAML authentication
SessionNotOnOrAfter value, whichever is shorter. You can provide
DurationSeconds value 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. 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.
The maximum session duration limit applies when you use the
API operations or the
assume-role* CLI operations but does not apply
when you use those operations to create a console URL. For more information, see Using IAM
Roles in the IAM User Guide.
The temporary security credentials created by
be used to make API calls to any AWS service with the following exception: you cannot
call the STS service's
Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by the intersection of both the access policy of the role that is being assumed, and the policy that you pass. This means that both policies must grant the permission for the action to be allowed. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.
Before your application can call
AssumeRoleWithSAML, you must configure
your SAML identity provider (IdP) to issue the claims required by AWS. Additionally,
you must use AWS Identity and Access Management (IAM) to create a SAML provider entity
in your AWS account that represents your identity provider, and create an IAM role
that specifies this SAML provider in its trust policy.
AssumeRoleWithSAML does not require the use of AWS security credentials.
The identity of the caller is validated by using keys in the metadata document that
is uploaded for the SAML provider entity for your identity provider.
AssumeRoleWithSAML can result in an entry in your AWS CloudTrail
logs. The entry includes the value in the
NameID element of the SAML
assertion. We recommend that you use a NameIDType that is not associated with any
personally identifiable information (PII). For example, you could instead use the
Persistent Identifier (
For more information, see the following resources:
About SAML 2.0-based Federation in the IAM User Guide.
Creating SAML Identity Providers in the IAM User Guide.
Configuring a Relying Party and Claims in the IAM User Guide.
Creating a Role for SAML 2.0 Federation in the IAM User Guide.
For .NET Core, PCL and Unity this operation is only available in asynchronous form. Please refer to AssumeRoleWithSAMLAsync.
public abstract AssumeRoleWithSAMLResponse AssumeRoleWithSAML( AssumeRoleWithSAMLRequest request )
Container for the necessary parameters to execute the AssumeRoleWithSAML service method.
|ExpiredTokenException||The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.|
|IDPRejectedClaimException||The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid. If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked.|
|InvalidIdentityTokenException||The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request.|
|MalformedPolicyDocumentException||The request was rejected because the policy document was malformed. The error message describes the specific error.|
|PackedPolicyTooLargeException||The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.|
|RegionDisabledException||STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.|
Supported in: 4.5, 4.0, 3.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone