List User Pool Clients

cognitoidentityprovider_list_user_pool_clients

R Documentation

Given a user pool ID, lists app clients

Description

Given a user pool ID, lists app clients. App clients are sets of rules for the access that you want a user pool to grant to one application. For more information, see App clients.

Amazon Cognito evaluates 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.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_list_user_pool_clients(UserPoolId, MaxResults,
  NextToken)

Arguments

UserPoolId	[required] The ID of the user pool where you want to list user pool clients.
MaxResults	The maximum number of app clients that you want Amazon Cognito to return in the response.
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(
  UserPoolClients = list(
    list(
      ClientId = "string",
      UserPoolId = "string",
      ClientName = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_user_pool_clients(
  UserPoolId = "string",
  MaxResults = 123,
  NextToken = "string"
)