Class: Aws::CognitoIdentity::Types::GetOpenIdTokenForDeveloperIdentityInput

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 GetOpenIdTokenForDeveloperIdentityInput data as a hash:

{
  identity_pool_id: "IdentityPoolId", # required
  identity_id: "IdentityId",
  logins: { # required
    "IdentityProviderName" => "IdentityProviderToken",
  },
  principal_tags: {
    "PrincipalTagID" => "PrincipalTagValue",
  },
  token_duration: 1,
}

Input to the GetOpenIdTokenForDeveloperIdentity action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#identity_idString

A unique identifier in the format REGION:GUID.

Returns:

  • (String)


574
575
576
577
578
579
580
581
582
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 574

class GetOpenIdTokenForDeveloperIdentityInput < Struct.new(
  :identity_pool_id,
  :identity_id,
  :logins,
  :principal_tags,
  :token_duration)
  SENSITIVE = []
  include Aws::Structure
end

#identity_pool_idString

An identity pool ID in the format REGION:GUID.

Returns:

  • (String)


574
575
576
577
578
579
580
581
582
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 574

class GetOpenIdTokenForDeveloperIdentityInput < Struct.new(
  :identity_pool_id,
  :identity_id,
  :logins,
  :principal_tags,
  :token_duration)
  SENSITIVE = []
  include Aws::Structure
end

#loginsHash<String,String>

A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier". The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

Returns:

  • (Hash<String,String>)


574
575
576
577
578
579
580
581
582
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 574

class GetOpenIdTokenForDeveloperIdentityInput < Struct.new(
  :identity_pool_id,
  :identity_id,
  :logins,
  :principal_tags,
  :token_duration)
  SENSITIVE = []
  include Aws::Structure
end

#principal_tagsHash<String,String>

Use this operation to configure attribute mappings for custom providers.

Returns:

  • (Hash<String,String>)


574
575
576
577
578
579
580
581
582
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 574

class GetOpenIdTokenForDeveloperIdentityInput < Struct.new(
  :identity_pool_id,
  :identity_id,
  :logins,
  :principal_tags,
  :token_duration)
  SENSITIVE = []
  include Aws::Structure
end

#token_durationInteger

The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.

Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.

Returns:

  • (Integer)


574
575
576
577
578
579
580
581
582
# File 'gems/aws-sdk-cognitoidentity/lib/aws-sdk-cognitoidentity/types.rb', line 574

class GetOpenIdTokenForDeveloperIdentityInput < Struct.new(
  :identity_pool_id,
  :identity_id,
  :logins,
  :principal_tags,
  :token_duration)
  SENSITIVE = []
  include Aws::Structure
end