AssumeRoleWithSAMLRequest Class

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.

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. The credentials are valid for the duration that you specified when calling

CopyC#

AssumeRoleWithSAML

, which can be up to 3600 seconds (1 hour) or until the time specified in the SAML authentication response's

CopyC#

NotOnOrAfter

value, whichever is shorter.

Note:
The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.

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 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, see Permissions for AssumeRoleWithSAML in Using Temporary Security Credentials.

Before your application can call

CopyC#

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.

Calling

CopyC#

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.

For more information, see the following resources:

Creating Temporary Security Credentials for SAML Federation in Using Temporary Security Credentials.
SAML Providers in Using IAM.
Configuring a Relying Party and Claims in Using IAM.
Creating a Role for SAML-Based Federation in Using IAM.

....

Declaration Syntax

public class AssumeRoleWithSAMLRequest : AmazonWebServiceRequest

Members

Icon

Member

Description

AssumeRoleWithSAMLRequest()()()()

Initializes a new instance of the AssumeRoleWithSAMLRequest class

DurationSeconds

Gets and sets the property DurationSeconds.

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's

CopyC#

NotOnOrAfter

value. The actual expiration time is whichever value is shorter.

Note:
The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.

Equals(Object)

Determines whether the specified Object is equal to the current Object.

(Inherited from Object.)

GetHashCode()()()()

Serves as a hash function for a particular type.

(Inherited from Object.)

GetType()()()()

Gets the type of the current instance.

(Inherited from Object.)

Policy

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, see Permissions for AssumeRoleWithSAML in Using Temporary Security Credentials.