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

Class: Aws::STS::Types::AssumeRoleWithWebIdentityResponse

Inherits:

Struct

• Object
• Struct
• Aws::STS::Types::AssumeRoleWithWebIdentityResponse

Defined in:

gems/aws-sdk-core/lib/aws-sdk-sts/types.rb

Overview

Contains the response to a successful AssumeRoleWithWebIdentity 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 Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials.

• #audience ⇒ String

  The intended audience (also known as client ID) of the web identity token.

• #credentials ⇒ Types::Credentials

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

• #packed_policy_size ⇒ Integer

  A percentage value that indicates the size of the policy in packed form.

• #provider ⇒ String

  The issuing authority of the web identity token presented.

• #subject_from_web_identity_token ⇒ String

  The unique user identifier that is returned by the identity provider.

Instance Attribute Details

#assumed_role_user ⇒ Types::AssumedRoleUser

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

Returns:

• (Types::AssumedRoleUser)

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

class AssumeRoleWithWebIdentityResponse < Struct.new(
  :credentials,
  :subject_from_web_identity_token,
  :assumed_role_user,
  :packed_policy_size,
  :provider,
  :audience)
  include Aws::Structure
end

#audience ⇒ String

The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.

Returns:

• (String)

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

class AssumeRoleWithWebIdentityResponse < Struct.new(
  :credentials,
  :subject_from_web_identity_token,
  :assumed_role_user,
  :packed_policy_size,
  :provider,
  :audience)
  include Aws::Structure
end

#credentials ⇒ Types::Credentials

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

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.

Returns:

• (Types::Credentials)

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

class AssumeRoleWithWebIdentityResponse < Struct.new(
  :credentials,
  :subject_from_web_identity_token,
  :assumed_role_user,
  :packed_policy_size,
  :provider,
  :audience)
  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 711

class AssumeRoleWithWebIdentityResponse < Struct.new(
  :credentials,
  :subject_from_web_identity_token,
  :assumed_role_user,
  :packed_policy_size,
  :provider,
  :audience)
  include Aws::Structure
end

#provider ⇒ String

The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.

Returns:

• (String)

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

class AssumeRoleWithWebIdentityResponse < Struct.new(
  :credentials,
  :subject_from_web_identity_token,
  :assumed_role_user,
  :packed_policy_size,
  :provider,
  :audience)
  include Aws::Structure
end

#subject_from_web_identity_token ⇒ String

The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.

Returns:

• (String)

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

class AssumeRoleWithWebIdentityResponse < Struct.new(
  :credentials,
  :subject_from_web_identity_token,
  :assumed_role_user,
  :packed_policy_size,
  :provider,
  :audience)
  include Aws::Structure
end