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

Contains information about a user pool client.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_token_validity ⇒ Integer

The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and cannot be used.

Returns:

  • (Integer) —

    The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and cannot be used.

#allowed_o_auth_flows ⇒ Array<String>

The allowed OAuth flows.

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 implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.

Returns:

  • (Array<String>) —

    The allowed OAuth flows.

#allowed_o_auth_flows_user_pool_client ⇒ Boolean

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_scopes ⇒ Array<String>

The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.

Returns:

  • (Array<String>) —

    The allowed OAuth scopes.

#analytics_configuration ⇒ Types::AnalyticsConfigurationType

The Amazon Pinpoint analytics configuration for the user pool client.

Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.

Returns:

#callback_urls ⇒ Array<String>

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Returns:

  • (Array<String>) —

    A list of allowed redirect (callback) URLs for the identity providers.

#client_id ⇒ String

The ID of the client associated with the user pool.

Returns:

  • (String) —

    The ID of the client associated with the user pool.

#client_name ⇒ String

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_secret ⇒ String

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_date ⇒ Time

The date the user pool client was created.

Returns:

  • (Time) —

    The date the user pool client was created.

#default_redirect_uri ⇒ String

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

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

Returns:

  • (String) —

    The default redirect URI.

#explicit_auth_flows ⇒ Array<String>

The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.

Valid values include:

  • ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.

  • ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.

  • ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.

  • ALLOW_USER_SRP_AUTH: Enable SRP based authentication.

  • ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.

Returns:

  • (Array<String>) —

    The authentication flows that are supported by the user pool clients.

#id_token_validity ⇒ Integer

The time limit, specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and cannot be used.

Returns:

  • (Integer) —

    The time limit, specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and cannot be used.

#last_modified_date ⇒ Time

The date the user pool client was last modified.

Returns:

  • (Time) —

    The date the user pool client was last modified.

#logout_urls ⇒ Array<String>

A list of allowed logout URLs for the identity providers.

Returns:

  • (Array<String>) —

    A list of allowed logout URLs for the identity providers.

#prevent_user_existence_errors ⇒ String

Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.

Valid values include:

  • ENABLED - This prevents user existence-related errors.

  • LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.

After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.

Possible values:

  • LEGACY
  • ENABLED

Returns:

  • (String) —

    Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool.

#read_attributes ⇒ Array<String>

The Read-only attributes.

Returns:

  • (Array<String>) —

    The Read-only attributes.

#refresh_token_validity ⇒ Integer

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_providers ⇒ Array<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.

#token_validity_units ⇒ Types::TokenValidityUnitsType

The time units used to specify the token validity times of their respective token.

Returns:

#user_pool_id ⇒ String

The user pool ID for the user pool client.

Returns:

  • (String) —

    The user pool ID for the user pool client.

#write_attributes ⇒ Array<String>

The writeable attributes.

Returns:

  • (Array<String>) —

    The writeable attributes.