Class: Aws::STS::Types::AssumeRoleWithSAMLResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::STS::Types::AssumeRoleWithSAMLResponse
- Defined in:
- gems/aws-sdk-core/lib/aws-sdk-sts/types.rb
Overview
Contains the response to a successful AssumeRoleWithSAML request, including temporary Amazon Web Services credentials that can be used to make Amazon Web Services requests.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#assumed_role_user ⇒ Types::AssumedRoleUser
The identifiers for the temporary security credentials that the operation returns.
-
#audience ⇒ String
The value of the
Recipient
attribute of theSubjectConfirmationData
element of the SAML assertion. -
#credentials ⇒ Types::Credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
-
#issuer ⇒ String
The value of the
Issuer
element of the SAML assertion. -
#name_qualifier ⇒ String
A hash value based on the concatenation of the following:.
-
#packed_policy_size ⇒ Integer
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
-
#source_identity ⇒ String
The value in the
SourceIdentity
attribute in the SAML assertion. -
#subject ⇒ String
The value of the
NameID
element in theSubject
element of the SAML assertion. -
#subject_type ⇒ String
The format of the name ID, as defined by the
Format
attribute in theNameID
element of the SAML assertion.
Instance Attribute Details
#assumed_role_user ⇒ Types::AssumedRoleUser
The identifiers for the temporary security credentials that the operation returns.
652 653 654 655 656 657 658 659 660 661 662 663 664 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 652 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier, :source_identity) SENSITIVE = [] include Aws::Structure end |
#audience ⇒ String
The value of the Recipient
attribute of the
SubjectConfirmationData
element of the SAML assertion.
652 653 654 655 656 657 658 659 660 661 662 663 664 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 652 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier, :source_identity) SENSITIVE = [] include Aws::Structure end |
#credentials ⇒ Types::Credentials
The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.
652 653 654 655 656 657 658 659 660 661 662 663 664 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 652 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier, :source_identity) SENSITIVE = [] include Aws::Structure end |
#issuer ⇒ String
The value of the Issuer
element of the SAML assertion.
652 653 654 655 656 657 658 659 660 661 662 663 664 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 652 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier, :source_identity) SENSITIVE = [] include Aws::Structure end |
#name_qualifier ⇒ String
A hash value based on the concatenation of the following:
The
Issuer
response value.The Amazon Web Services account ID.
The friendly name (the last part of the ARN) of the SAML provider in IAM.
The combination of NameQualifier
and Subject
can be used to
uniquely identify a user.
The following pseudocode shows how the hash value is calculated:
BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" +
"/MySAMLIdP" ) )
652 653 654 655 656 657 658 659 660 661 662 663 664 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 652 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier, :source_identity) SENSITIVE = [] include Aws::Structure end |
#packed_policy_size ⇒ Integer
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request. The request fails if the packed size is greater than 100 percent, which means the policies and tags exceeded the allowed space.
652 653 654 655 656 657 658 659 660 661 662 663 664 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 652 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier, :source_identity) SENSITIVE = [] include Aws::Structure end |
#source_identity ⇒ String
The value in the SourceIdentity
attribute in the SAML assertion.
The source identity value persists across chained role
sessions.
You can require users to set a source identity value when they
assume a role. You do this by using the sts:SourceIdentity
condition key in a role trust policy. That way, actions that are
taken with the role are associated with that user. After the source
identity is set, the value cannot be changed. It is present in the
request for all actions that are taken by the role and persists
across chained role sessions. You can configure your SAML
identity provider to use an attribute associated with your users,
like user name or email, as the source identity when calling
AssumeRoleWithSAML
. You do this by adding an attribute to the SAML
assertion. For more information about using source identity, see
Monitor and control actions taken with assumed roles in the
IAM User Guide.
The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-
652 653 654 655 656 657 658 659 660 661 662 663 664 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 652 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier, :source_identity) SENSITIVE = [] include Aws::Structure end |
#subject ⇒ String
The value of the NameID
element in the Subject
element of the
SAML assertion.
652 653 654 655 656 657 658 659 660 661 662 663 664 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 652 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier, :source_identity) SENSITIVE = [] include Aws::Structure end |
#subject_type ⇒ String
The format of the name ID, as defined by the Format
attribute in
the NameID
element of the SAML assertion. Typical examples of the
format are transient
or persistent
.
If the format includes the prefix
urn:oasis:names:tc:SAML:2.0:nameid-format
, that prefix is removed.
For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient
is returned as transient
. If the format includes any other prefix,
the format is returned with no modifications.
652 653 654 655 656 657 658 659 660 661 662 663 664 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 652 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier, :source_identity) SENSITIVE = [] include Aws::Structure end |