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

Class: Aws::CognitoIdentityProvider::Types::UserPoolClientType

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_o_auth_flowsArray<String>

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Returns:

  • (Array<String>)

    Set to code to initiate a code grant flow, which provides an authorization code as the response.

#allowed_o_auth_flows_user_pool_clientBoolean

Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

Returns:

  • (Boolean)

    Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

#allowed_o_auth_scopesArray<String>

A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".

Returns:

  • (Array<String>)

    A list of allowed OAuth scopes.

#callback_urlsArray<String>

A list of allowed callback URLs for the identity providers.

Returns:

  • (Array<String>)

    A list of allowed callback URLs for the identity providers.

#client_idString

The ID of the client associated with the user pool.

Returns:

  • (String)

    The ID of the client associated with the user pool.

#client_nameString

The client name from the user pool request of the client type.

Returns:

  • (String)

    The client name from the user pool request of the client type.

#client_secretString

The client secret from the user pool request of the client type.

Returns:

  • (String)

    The client secret from the user pool request of the client type.

#creation_dateTime

The date the user pool client was created.

Returns:

  • (Time)

    The date the user pool client was created.

#default_redirect_uriString

The default redirect URI. Must be in the CallbackURLs list.

Returns:

  • (String)

    The default redirect URI.

#explicit_auth_flowsArray<String>

The explicit authentication flows.

Returns:

  • (Array<String>)

    The explicit authentication flows.

#last_modified_dateTime

The date the user pool client was last modified.

Returns:

  • (Time)

    The date the user pool client was last modified.

#logout_urlsArray<String>

A list of allowed logout URLs for the identity providers.

Returns:

  • (Array<String>)

    A list of allowed logout URLs for the identity providers.

#read_attributesArray<String>

The Read-only attributes.

Returns:

  • (Array<String>)

    The Read-only attributes.

#refresh_token_validityInteger

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

Returns:

  • (Integer)

    The time limit, in days, after which the refresh token is no longer valid and cannot be used.

#supported_identity_providersArray<String>

A list of provider names for the identity providers that are supported on this client.

Returns:

  • (Array<String>)

    A list of provider names for the identity providers that are supported on this client.

#user_pool_idString

The user pool ID for the user pool client.

Returns:

  • (String)

    The user pool ID for the user pool client.

#write_attributesArray<String>

The writeable attributes.

Returns:

  • (Array<String>)

    The writeable attributes.