DescribeUserPoolClient
Given an app client ID, returns configuration information. This operation is useful when you want to inspect an existing app client and programmatically replicate the configuration to another app client. For more information about app clients, see App clients.
Note
Amazon Cognito evaluates Amazon Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Request Syntax
{
"ClientId": "string
",
"UserPoolId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientId
-
The ID of the app client that you want to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+]+
Required: Yes
- UserPoolId
-
The ID of the user pool that contains the app client you want to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: Yes
Response Syntax
{
"UserPoolClient": {
"AccessTokenValidity": number,
"AllowedOAuthFlows": [ "string" ],
"AllowedOAuthFlowsUserPoolClient": boolean,
"AllowedOAuthScopes": [ "string" ],
"AnalyticsConfiguration": {
"ApplicationArn": "string",
"ApplicationId": "string",
"ExternalId": "string",
"RoleArn": "string",
"UserDataShared": boolean
},
"AuthSessionValidity": number,
"CallbackURLs": [ "string" ],
"ClientId": "string",
"ClientName": "string",
"ClientSecret": "string",
"CreationDate": number,
"DefaultRedirectURI": "string",
"EnablePropagateAdditionalUserContextData": boolean,
"EnableTokenRevocation": boolean,
"ExplicitAuthFlows": [ "string" ],
"IdTokenValidity": number,
"LastModifiedDate": number,
"LogoutURLs": [ "string" ],
"PreventUserExistenceErrors": "string",
"ReadAttributes": [ "string" ],
"RefreshTokenValidity": number,
"SupportedIdentityProviders": [ "string" ],
"TokenValidityUnits": {
"AccessToken": "string",
"IdToken": "string",
"RefreshToken": "string"
},
"UserPoolId": "string",
"WriteAttributes": [ "string" ]
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- UserPoolClient
-
The details of the request app client.
Type: UserPoolClientType object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: