[ aws . cognito-idp ]
Client method for returning the configuration information and metadata of the specified user pool app client.
See also: AWS API Documentation
describe-user-pool-client
--user-pool-id <value>
--client-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--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
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--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
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To describe a user pool client
This example describes a user pool client.
Command:
aws cognito-idp describe-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0
Output:
{
"UserPoolClient": {
"UserPoolId": "us-west-2_aaaaaaaaa",
"ClientName": "MyApp",
"ClientId": "38fjsnc484p94kpqsnet7mpld0",
"ClientSecret": "CLIENT_SECRET",
"LastModifiedDate": 1548108676.163,
"CreationDate": 1548108676.163,
"RefreshTokenValidity": 30,
"ReadAttributes": [
"address",
"birthdate",
"custom:CustomAttr1",
"custom:CustomAttr2",
"email",
"email_verified",
"family_name",
"gender",
"given_name",
"locale",
"middle_name",
"name",
"nickname",
"phone_number",
"phone_number_verified",
"picture",
"preferred_username",
"profile",
"updated_at",
"website",
"zoneinfo"
],
"WriteAttributes": [
"address",
"birthdate",
"custom:CustomAttr1",
"custom:CustomAttr2",
"email",
"family_name",
"gender",
"given_name",
"locale",
"middle_name",
"name",
"nickname",
"phone_number",
"picture",
"preferred_username",
"profile",
"updated_at",
"website",
"zoneinfo"
],
"ExplicitAuthFlows": [
"ADMIN_NO_SRP_AUTH",
"USER_PASSWORD_AUTH"
],
"AllowedOAuthFlowsUserPoolClient": false
}
}
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 refresh token time limit. After this limit expires, your user can’t use their refresh token. To specify the time unit for
RefreshTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
RefreshTokenValidity
as10
andTokenValidityUnits
asdays
, your user can refresh their session and retrieve new access and ID tokens for 10 days.The default time unit for
RefreshTokenValidity
in an API request is days. You can’t setRefreshTokenValidity
to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.If you don’t specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
AccessTokenValidity -> (integer)
The access token time limit. After this limit expires, your user can’t use their access token. To specify the time unit for
AccessTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
AccessTokenValidity
to10
andTokenValidityUnits
tohours
, your user can authorize access with their access token for 10 hours.The default time unit for
AccessTokenValidity
in an API request is hours. Valid range is displayed below in seconds.If you don’t specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
IdTokenValidity -> (integer)
The ID token time limit. After this limit expires, your user can’t use their ID token. To specify the time unit for
IdTokenValidity
asseconds
,minutes
,hours
, ordays
, set aTokenValidityUnits
value in your API request.For example, when you set
IdTokenValidity
as10
andTokenValidityUnits
ashours
, your user can authenticate their session with their ID token for 10 hours.The default time unit for
AccessTokenValidity
in an API request is hours. Valid range is displayed below in seconds.If you don’t specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
TokenValidityUnits -> (structure)
The time units used to specify the token validity times of each token type: ID, access, and refresh.
AccessToken -> (string)
A time unit of
seconds
,minutes
,hours
, ordays
for the value that you set in theAccessTokenValidity
parameter. The defaultAccessTokenValidity
time unit is hours.IdToken -> (string)
A time unit of
seconds
,minutes
,hours
, ordays
for the value that you set in theIdTokenValidity
parameter. The defaultIdTokenValidity
time unit is hours.RefreshToken -> (string)
A time unit of
seconds
,minutes
,hours
, ordays
for the value that you set in theRefreshTokenValidity
parameter. The defaultRefreshTokenValidity
time unit is days.ReadAttributes -> (list)
The Read-only attributes.
(string)
WriteAttributes -> (list)
The writeable attributes.
(string)
ExplicitAuthFlows -> (list)
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
Note
If you don’t specify a value for
ExplicitAuthFlows
, your user client supportsALLOW_REFRESH_TOKEN_AUTH
,ALLOW_USER_SRP_AUTH
, andALLOW_CUSTOM_AUTH
.Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH
: Enable admin based user password authentication flowADMIN_USER_PASSWORD_AUTH
. This setting replaces theADMIN_NO_SRP_AUTH
setting. With this authentication flow, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH
: Enable Lambda trigger based authentication.
ALLOW_USER_PASSWORD_AUTH
: Enable user password-based authentication. In this flow, Amazon 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.In some environments, you will see the values
ADMIN_NO_SRP_AUTH
,CUSTOM_AUTH_FLOW_ONLY
, orUSER_PASSWORD_AUTH
. You can’t assign these legacyExplicitAuthFlows
values to user pool clients at the same time as values that begin withALLOW_
, likeALLOW_USER_SRP_AUTH
.(string)
SupportedIdentityProviders -> (list)
A list of provider names for the IdPs that this client supports. The following are supported:
COGNITO
,SignInWithApple
,LoginWithAmazon
, and the names of your own SAML and OIDC providers.(string)
CallbackURLs -> (list)
A list of allowed redirect (callback) URLs for the IdPs.
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.
(string)
LogoutURLs -> (list)
A list of allowed logout URLs for the IdPs.
(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 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.
AllowedOAuthFlows -> (list)
The allowed OAuth flows.
code
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the
/oauth2/token
endpoint.implicit
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
client_credentials
Issue the access token from the
/oauth2/token
endpoint directly to a non-person user using a combination of the client ID and client secret.(string)
AllowedOAuthScopes -> (list)
The OAuth scopes that your app client supports. Possible values that OAuth provides are
phone
,openid
, andprofile
. Possible values that Amazon Web Services provides areaws.cognito.signin.user.admin
. Amazon Cognito also supports custom scopes that you create in Resource Servers.(string)
AllowedOAuthFlowsUserPoolClient -> (boolean)
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
AnalyticsConfiguration -> (structure)
The Amazon Pinpoint analytics configuration for the user pool client.
Note
Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
ApplicationId -> (string)
The application ID for an Amazon Pinpoint application.
ApplicationArn -> (string)
The Amazon Resource Name (ARN) of an Amazon Pinpoint project. You can use the Amazon Pinpoint project to integrate with the chosen user pool Client. Amazon Cognito publishes events to the Amazon Pinpoint project that the app ARN declares.
RoleArn -> (string)
The ARN of an Identity and Access Management role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
ExternalId -> (string)
The external ID.
UserDataShared -> (boolean)
If
UserDataShared
istrue
, Amazon Cognito includes user data in the events that it publishes to Amazon Pinpoint analytics.PreventUserExistenceErrors -> (string)
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn’t exist in the user pool. When set to
ENABLED
and the user doesn’t exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set toLEGACY
, those APIs return aUserNotFoundException
exception if the user doesn’t exist in the user pool.Valid values include:
ENABLED
- This prevents user existence-related errors.
LEGACY
- This represents the old behavior of Amazon Cognito where user existence related errors aren’t prevented.EnableTokenRevocation -> (boolean)
Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken .
EnablePropagateAdditionalUserContextData -> (boolean)
When
EnablePropagateAdditionalUserContextData
is true, Amazon Cognito accepts anIpAddress
value that you send in theUserContextData
parameter. TheUserContextData
parameter sends information to Amazon Cognito advanced security for risk analysis. You can sendUserContextData
when you sign in Amazon Cognito native users with theInitiateAuth
andRespondToAuthChallenge
API operations.When
EnablePropagateAdditionalUserContextData
is false, you can’t send your user’s source IP address to Amazon Cognito advanced security with unauthenticated API operations.EnablePropagateAdditionalUserContextData
doesn’t affect whether you can send a source IP address in aContextData
parameter with the authenticated API operationsAdminInitiateAuth
andAdminRespondToAuthChallenge
.You can only activate
EnablePropagateAdditionalUserContextData
in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests .AuthSessionValidity -> (integer)
Amazon Cognito creates a session token for each API request in an authentication flow.
AuthSessionValidity
is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.