Class: Aws::STS::Types::AssumeRoleWithSAMLResponse

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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

Method Summary

Methods included from Aws::Structure

#empty?, included, #initialize, #key?, new, #to_h, #to_s

Instance Attribute Details

#assumed_role_userTypes::AssumedRoleUser

The identifiers for the temporary security credentials that the operation returns.


654
655
656
657
658
659
660
661
662
663
664
665
666
# File 'lib/aws-sdk-sts/types.rb', line 654

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

#audienceString

The value of the `Recipient` attribute of the `SubjectConfirmationData` element of the SAML assertion.

Returns:

  • (String)

654
655
656
657
658
659
660
661
662
663
664
665
666
# File 'lib/aws-sdk-sts/types.rb', line 654

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

#credentialsTypes::Credentials

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

<note markdown=“1”> The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

</note>

Returns:


654
655
656
657
658
659
660
661
662
663
664
665
666
# File 'lib/aws-sdk-sts/types.rb', line 654

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

#issuerString

The value of the `Issuer` element of the SAML assertion.

Returns:

  • (String)

654
655
656
657
658
659
660
661
662
663
664
665
666
# File 'lib/aws-sdk-sts/types.rb', line 654

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_qualifierString

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 federated user.

The following pseudocode shows how the hash value is calculated:

`BASE64 ( SHA1 ( “example.com/saml” + “123456789012” + “/MySAMLIdP” ) )`

Returns:

  • (String)

654
655
656
657
658
659
660
661
662
663
664
665
666
# File 'lib/aws-sdk-sts/types.rb', line 654

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_sizeInteger

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.

Returns:

  • (Integer)

654
655
656
657
658
659
660
661
662
663
664
665
666
# File 'lib/aws-sdk-sts/types.rb', line 654

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_identityString

The value in the `SourceIdentity` attribute in the SAML assertion.

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][2

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: =,[email protected]

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts#iam-term-role-chaining [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_monitor.html

Returns:

  • (String)

654
655
656
657
658
659
660
661
662
663
664
665
666
# File 'lib/aws-sdk-sts/types.rb', line 654

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

#subjectString

The value of the `NameID` element in the `Subject` element of the SAML assertion.

Returns:

  • (String)

654
655
656
657
658
659
660
661
662
663
664
665
666
# File 'lib/aws-sdk-sts/types.rb', line 654

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_typeString

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.

Returns:

  • (String)

654
655
656
657
658
659
660
661
662
663
664
665
666
# File 'lib/aws-sdk-sts/types.rb', line 654

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