Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListUserPoolClientSecrets

Lists all client secrets associated with a user pool app client. Returns metadata about the secrets. The response does not include pagination tokens as there are only 2 secrets at any given time and we return both with every ListUserPoolClientSecrets call. For security reasons, the response never reveals the actual secret value in ClientSecretValue.

Request Syntax


{
   "ClientId": "string",
   "NextToken": "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 whose secrets you want to list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+]+

Required: Yes

NextToken

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 131072.

Pattern: [\S]+

Required: No

UserPoolId

The ID of the user pool that contains the app client.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+_[0-9a-zA-Z]+

Required: Yes

Response Syntax


{
   "ClientSecrets": [ 
      { 
         "ClientSecretCreateDate": number,
         "ClientSecretId": "string",
         "ClientSecretValue": "string"
      }
   ],
   "NextToken": "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.

ClientSecrets

A list of client secret descriptors containing the identifier and creation date for each secret. For security reasons, the response never reveals the actual secret value in ClientSecretValue.

Type: Array of ClientSecretDescriptorType objects

NextToken

The identifier that Amazon Cognito returned with the previous request to this operation. When you include a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token, you can paginate through the full list of items.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 131072.

Pattern: [\S]+

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

This exception is thrown when Amazon Cognito encounters an internal server error.

HTTP Status Code: 500

InvalidParameterException

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

message: The message returned when the Amazon Cognito service throws an invalid parameter exception.
reasonCode: The reason code of the exception.

HTTP Status Code: 400

LimitExceededException

This exception is thrown when a user exceeds the limit for a requested AWS resource.

message: The message returned when Amazon Cognito throws a limit exceeded exception.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when the Amazon Cognito service can't find the requested resource.

message: The message returned when the Amazon Cognito service returns a resource not found exception.

HTTP Status Code: 400

TooManyRequestsException

This exception is thrown when the user has made too many requests for a given operation.

message: The message returned when the Amazon Cognito service returns a too many requests exception.

HTTP Status Code: 400