LISTUSERPOOLCLIENTS()`¶

About ListUserPoolClients¶

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

Method Signature¶

METHODS /AWS1/IF_CGP~LISTUSERPOOLCLIENTS
  IMPORTING
    !IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CGPQUERYLIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CGPPAGINATIONKEY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgplstuserpoolclisrsp
  RAISING
    /AWS1/CX_CGPINTERNALERROREX
    /AWS1/CX_CGPINVALIDPARAMETEREX
    /AWS1/CX_CGPNOTAUTHORIZEDEX
    /AWS1/CX_CGPRESOURCENOTFOUNDEX
    /AWS1/CX_CGPTOOMANYREQUESTSEX
    /AWS1/CX_CGPCLIENTEXC
    /AWS1/CX_CGPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_userpoolid` `TYPE /AWS1/CGPUSERPOOLIDTYPE` `/AWS1/CGPUSERPOOLIDTYPE`¶

The ID of the user pool where you want to list user pool clients.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/CGPQUERYLIMIT` `/AWS1/CGPQUERYLIMIT`¶

The maximum number of app clients that you want Amazon Cognito to return in the response.

`iv_nexttoken` `TYPE /AWS1/CGPPAGINATIONKEY` `/AWS1/CGPPAGINATIONKEY`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cgplstuserpoolclisrsp` `/AWS1/CL_CGPLSTUSERPOOLCLISRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listuserpoolclients(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_userpoolid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_userpoolclients( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_clientidtype = lo_row_1->get_clientid( ).
      lv_userpoolidtype = lo_row_1->get_userpoolid( ).
      lv_clientnametype = lo_row_1->get_clientname( ).
    ENDIF.
  ENDLOOP.
  lv_paginationkey = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_CGP=>LISTUSERPOOLCLIENTS()¶