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.
Container for the parameters to the AssumeRoleWithSAML operation.
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:
public class AssumeRoleWithSAMLRequest : AmazonSecurityTokenServiceRequest IAmazonWebServiceRequest
The AssumeRoleWithSAMLRequest type exposes the following members
Gets and sets the property DurationSeconds.
The duration, in seconds, of the role session. Your role session lasts for the duration
that you specify for the
By default, the value is set to 3600 seconds.
Gets and sets the property Policy.
An IAM policy in JSON format.
The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. 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, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.
The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.
The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.
Gets and sets the property PrincipalArn.
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
Gets and sets the property RoleArn.
The Amazon Resource Name (ARN) of the role that the caller is assuming.
Gets and sets the property SAMLAssertion.
The base-64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.
Supported in: 1.3
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