Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . cognito-idp ]

describe-user-pool-client

Description

Client method for returning the configuration information and metadata of the specified user pool client.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-user-pool-client
--user-pool-id <value>
--client-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--user-pool-id (string)

The user pool ID for the user pool you want to describe.

--client-id (string)

The app client ID of the app associated with the user pool.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

UserPoolClient -> (structure)

The user pool client from a server response to describe the user pool client.

UserPoolId -> (string)

The user pool ID for the user pool client.

ClientName -> (string)

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

ClientId -> (string)

The ID of the client associated with the user pool.

ClientSecret -> (string)

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

LastModifiedDate -> (timestamp)

The date the user pool client was last modified.

CreationDate -> (timestamp)

The date the user pool client was created.

RefreshTokenValidity -> (integer)

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

ReadAttributes -> (list)

The Read-only attributes.

(string)

WriteAttributes -> (list)

The writeable attributes.

(string)

ExplicitAuthFlows -> (list)

The explicit authentication flows.

(string)

SupportedIdentityProviders -> (list)

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

(string)

CallbackURLs -> (list)

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 use HTTP without TLS (i.e. use HTTPS instead of HTTP).
  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint .

(string)

LogoutURLs -> (list)

A list of allowed logout URLs for the identity providers.

(string)

DefaultRedirectURI -> (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 use HTTP without TLS (i.e. use HTTPS instead of HTTP).
  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint .

AllowedOAuthFlows -> (list)

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.

(string)

AllowedOAuthScopes -> (list)

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

(string)

AllowedOAuthFlowsUserPoolClient -> (boolean)

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

AnalyticsConfiguration -> (structure)

The Amazon Pinpoint analytics configuration for the user pool client.

ApplicationId -> (string)

The application ID for an Amazon Pinpoint application.

RoleArn -> (string)

The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

ExternalId -> (string)

The external ID.

UserDataShared -> (boolean)

If UserDataShared is true , Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.