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 AWS credentials that can be used to make AWS 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
Issuer
response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. -
#packed_policy_size ⇒ Integer
A percentage value that indicates the packed size of the session policies and session tags combined passed in the request.
-
#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.
554 555 556 557 558 559 560 561 562 563 564 565 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 554 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier) SENSITIVE = [] include Aws::Structure end |
#audience ⇒ String
The value of the Recipient
attribute of the
SubjectConfirmationData
element of the SAML assertion.
554 555 556 557 558 559 560 561 562 563 564 565 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 554 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier) 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.
554 555 556 557 558 559 560 561 562 563 564 565 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 554 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier) SENSITIVE = [] include Aws::Structure end |
#issuer ⇒ String
The value of the Issuer
element of the SAML assertion.
554 555 556 557 558 559 560 561 562 563 564 565 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 554 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier) SENSITIVE = [] include Aws::Structure end |
#name_qualifier ⇒ String
A hash value based on the concatenation of the Issuer
response
value, the AWS account ID, and 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
federated user.
The following pseudocode shows how the hash value is calculated:
BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" +
"/MySAMLIdP" ) )
554 555 556 557 558 559 560 561 562 563 564 565 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 554 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier) 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.
554 555 556 557 558 559 560 561 562 563 564 565 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 554 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier) SENSITIVE = [] include Aws::Structure end |
#subject ⇒ String
The value of the NameID
element in the Subject
element of the
SAML assertion.
554 555 556 557 558 559 560 561 562 563 564 565 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 554 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier) 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.
554 555 556 557 558 559 560 561 562 563 564 565 |
# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 554 class AssumeRoleWithSAMLResponse < Struct.new( :credentials, :assumed_role_user, :packed_policy_size, :subject, :subject_type, :issuer, :audience, :name_qualifier) SENSITIVE = [] include Aws::Structure end |