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

Class: Aws::CognitoIdentity::Types::GetOpenIdTokenInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb

Overview

Note:

When making an API call, you may pass GetOpenIdTokenInput data as a hash:

{
  identity_id: "IdentityId", # required
  logins: {
    "IdentityProviderName" => "IdentityProviderToken",
  },
}

Input to the GetOpenIdToken action.

Instance Attribute Summary collapse

Instance Attribute Details

#identity_idString

A unique identifier in the format REGION:GUID.

Returns:

  • (String)


509
510
511
512
513
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 509

class GetOpenIdTokenInput < Struct.new(
  :identity_id,
  :logins)
  include Aws::Structure
end

#loginsHash<String,String>

A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito Identity Provider, or any other OpenId Connect provider, always include the id_token.

Returns:

  • (Hash<String,String>)


509
510
511
512
513
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 509

class GetOpenIdTokenInput < Struct.new(
  :identity_id,
  :logins)
  include Aws::Structure
end