List User Pool Client Secrets

cognitoidentityprovider_list_user_pool_client_secrets

R Documentation

Lists all client secrets associated with a user pool app client¶

Description¶

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.

Usage¶

cognitoidentityprovider_list_user_pool_client_secrets(UserPoolId,
  ClientId, NextToken)

Arguments¶

UserPoolId

[required] The ID of the user pool that contains the app client.

ClientId

[required] The ID of the app client whose secrets you want to list.

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.

Value¶

A list with the following syntax:

list(
  ClientSecrets = list(
    list(
      ClientSecretId = "string",
      ClientSecretValue = "string",
      ClientSecretCreateDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_user_pool_client_secrets(
  UserPoolId = "string",
  ClientId = "string",
  NextToken = "string"
)