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 AssumeRoleWithSAML with the other
API operations that produce temporary credentials, see Requesting Temporary Security Credentials
and Comparing the AWS STS API operations
in the IAM User Guide.
sts_assume_role_with_saml(RoleArn, PrincipalArn, SAMLAssertion,
PolicyArns, Policy, DurationSeconds)[required] The Amazon Resource Name (ARN) of the role that the caller is assuming.
[required] The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.
[required] The base-64 encoded SAML authentication response provided by the IdP.
For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.
The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.
This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
The characters in this parameter count towards the 2048 character
session policy guideline. However, an AWS conversion compresses the
session policies into a packed binary format that has a separate limit.
This is the enforced limit. The PackedPolicySize response element
indicates by percentage how close the policy is to the upper size limit.
Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
An IAM policy in JSON format that you want to use as an inline session policy.
This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.
The plain text that you use for both inline and managed session policies
shouldn't exceed 2048 characters. The JSON policy characters can be any
ASCII character from the space character to the end of the valid
character list (U+0020 through U+00FF). It can also include the tab
(U+0009), linefeed (U+000A), and carriage return (U+000D) characters.
The characters in this parameter count towards the 2048 character
session policy guideline. However, an AWS conversion compresses the
session policies into a packed binary format that has a separate limit.
This is the enforced limit. The PackedPolicySize response element
indicates by percentage how close the policy is to the upper size limit.
The duration, in seconds, of the role session. Your role session lasts
for the duration that you specify for the DurationSeconds parameter,
or until the time specified in the SAML authentication response's
SessionNotOnOrAfter value, whichever is shorter. You can provide a
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. If you specify a value higher than this
setting, the operation fails. For example, if you specify a session
duration of 12 hours, but your administrator set the maximum session
duration to 6 hours, your operation fails. 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.
By default, the value is set to 3600 seconds.
The DurationSeconds parameter is separate from the duration of a
console session that you might request using the returned credentials.
The request to the federation endpoint for a console sign-in token takes
a SessionDuration parameter that specifies the maximum length of the
console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console
in the IAM User Guide.
svc$assume_role_with_saml(
RoleArn = "string",
PrincipalArn = "string",
SAMLAssertion = "string",
PolicyArns = list(
list(
arn = "string"
)
),
Policy = "string",
DurationSeconds = 123
)
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
AssumeRoleWithSAML last for one hour. However, you can use the
optional DurationSeconds 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 response's
SessionNotOnOrAfter value, whichever is shorter. You can provide a
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 AssumeRole* API operations or the assume-role* CLI
commands. However the limit 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 AssumeRoleWithSAML can
be used to make API calls to any AWS service with the following
exception: you cannot call the STS GetFederationToken or
GetSessionToken API operations.
(Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies 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. You must also 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.
Calling 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
(urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).
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.