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.
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 AssumeRoleWithSAML
, which
can be up to 3600 seconds (1 hour) or until the time specified in the SAML authentication
response's SessionNotOnOrAfter
value, whichever is shorter.
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 AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the Using IAM.
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.
Calling 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:
Namespace: Amazon.SecurityToken.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class AssumeRoleWithSAMLRequest : AmazonSecurityTokenServiceRequest IRequestEvents
The AssumeRoleWithSAMLRequest type exposes the following members
Name | Description | |
---|---|---|
AssumeRoleWithSAMLRequest() |
Name | Type | Description | |
---|---|---|---|
DurationSeconds | System.Int32 |
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 |
|
Policy | System.String |
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 Using IAM. |
|
PrincipalArn | System.String |
Gets and sets the property PrincipalArn.
The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. |
|
RoleArn | System.String |
Gets and sets the property RoleArn.
The Amazon Resource Name (ARN) of the role that the caller is assuming. |
|
SAMLAssertion | System.String |
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. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8