Class: Aws::CognitoIdentityProvider::Types::GetClientTokenRequest

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::GetClientTokenRequest

Defined in:

gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:client_id, :secret]

Instance Attribute Summary

• #client_id ⇒ String

  The ID of the app client that requests the access token.

• #client_metadata ⇒ Hash<String,String>

  A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

• #scopes ⇒ Array<String>

  The custom scopes to authorize in the access token, in the format resource-server-identifier/scope-name.

• #secret ⇒ String

  An active secret for the app client.

Instance Attribute Details

#client_id ⇒ String

The ID of the app client that requests the access token. The app client must have a client secret and the ALLOW_CLIENT_TOKEN_AUTH authentication flow.

Returns:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6788

class GetClientTokenRequest < Struct.new(
  :client_id,
  :secret,
  :scopes,
  :client_metadata)
  SENSITIVE = [:client_id, :secret]
  include Aws::Structure
end

#client_metadata ⇒ Hash<String,String>

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning Lambda functions to user pool triggers.

When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute that provides the data that you assigned to the ClientMetadata parameter in your request. In your function code, you can process the clientMetadata value to enhance your workflow for your specific needs.

To review the Lambda trigger types that Amazon Cognito invokes at runtime with API requests, see Connecting API actions to Lambda triggers in the Amazon Cognito Developer Guide.

When you use the ClientMetadata parameter, note that Amazon Cognito won't do the following:

• Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.

• Validate the ClientMetadata value.

• Encrypt the ClientMetadata value. Don't send sensitive information in this parameter.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6788

class GetClientTokenRequest < Struct.new(
  :client_id,
  :secret,
  :scopes,
  :client_metadata)
  SENSITIVE = [:client_id, :secret]
  include Aws::Structure
end

#scopes ⇒ Array<String>

The custom scopes to authorize in the access token, in the format resource-server-identifier/scope-name. Each scope must belong to a resource server in your user pool. If you don't specify any scopes, Amazon Cognito authorizes the scopes that are configured for the app client.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6788

class GetClientTokenRequest < Struct.new(
  :client_id,
  :secret,
  :scopes,
  :client_metadata)
  SENSITIVE = [:client_id, :secret]
  include Aws::Structure
end

#secret ⇒ String

An active secret for the app client.

Returns:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6788

class GetClientTokenRequest < Struct.new(
  :client_id,
  :secret,
  :scopes,
  :client_metadata)
  SENSITIVE = [:client_id, :secret]
  include Aws::Structure
end