AWS SDK for .NET Documentation
AssumeRoleWithSAML Method (request)
AmazonAmazon.SecurityTokenAmazonSecurityTokenServiceAssumeRoleWithSAML(AssumeRoleWithSAMLRequest) Did this page help you?   Yes   No    Tell us about it...
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:

....
Declaration Syntax
Parameters
request (AssumeRoleWithSAMLRequest)
Container for the necessary parameters to execute the AssumeRoleWithSAML service method.
Return Value
The response from the AssumeRoleWithSAML service method, as returned by SecurityTokenService.
Exceptions
ExceptionCondition
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

CopyC#
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.

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)