You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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 the SubjectConfirmationData 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 size of the policy in packed form.

• #subject ⇒ String

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

• #subject_type ⇒ String

  The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion.

Instance Attribute Details

#assumed_role_user ⇒ Types::AssumedRoleUser

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

Returns:

• (Types::AssumedRoleUser)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 387

class AssumeRoleWithSAMLResponse < Struct.new(
  :credentials,
  :assumed_role_user,
  :packed_policy_size,
  :subject,
  :subject_type,
  :issuer,
  :audience,
  :name_qualifier)
  include Aws::Structure
end

#audience ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 387

class AssumeRoleWithSAMLResponse < Struct.new(
  :credentials,
  :assumed_role_user,
  :packed_policy_size,
  :subject,
  :subject_type,
  :issuer,
  :audience,
  :name_qualifier)
  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.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

Returns:

• (Types::Credentials)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 387

class AssumeRoleWithSAMLResponse < Struct.new(
  :credentials,
  :assumed_role_user,
  :packed_policy_size,
  :subject,
  :subject_type,
  :issuer,
  :audience,
  :name_qualifier)
  include Aws::Structure
end

#issuer ⇒ String

The value of the Issuer element of the SAML assertion.

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 387

class AssumeRoleWithSAMLResponse < Struct.new(
  :credentials,
  :assumed_role_user,
  :packed_policy_size,
  :subject,
  :subject_type,
  :issuer,
  :audience,
  :name_qualifier)
  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" ) )

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 387

class AssumeRoleWithSAMLResponse < Struct.new(
  :credentials,
  :assumed_role_user,
  :packed_policy_size,
  :subject,
  :subject_type,
  :issuer,
  :audience,
  :name_qualifier)
  include Aws::Structure
end

#packed_policy_size ⇒ Integer

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

Returns:

• (Integer)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 387

class AssumeRoleWithSAMLResponse < Struct.new(
  :credentials,
  :assumed_role_user,
  :packed_policy_size,
  :subject,
  :subject_type,
  :issuer,
  :audience,
  :name_qualifier)
  include Aws::Structure
end

#subject ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 387

class AssumeRoleWithSAMLResponse < Struct.new(
  :credentials,
  :assumed_role_user,
  :packed_policy_size,
  :subject,
  :subject_type,
  :issuer,
  :audience,
  :name_qualifier)
  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.

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-sts/types.rb', line 387

class AssumeRoleWithSAMLResponse < Struct.new(
  :credentials,
  :assumed_role_user,
  :packed_policy_size,
  :subject,
  :subject_type,
  :issuer,
  :audience,
  :name_qualifier)
  include Aws::Structure
end