ADMINLISTGROUPSFORUSER()`¶

About AdminListGroupsForUser¶

Lists the groups that a user belongs to. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.

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~ADMINLISTGROUPSFORUSER
  IMPORTING
    !IV_USERNAME TYPE /AWS1/CGPUSERNAMETYPE OPTIONAL
    !IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE OPTIONAL
    !IV_LIMIT TYPE /AWS1/CGPQUERYLIMITTYPE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CGPPAGINATIONKEY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgpadminlstgrsforus01
  RAISING
    /AWS1/CX_CGPINTERNALERROREX
    /AWS1/CX_CGPINVALIDPARAMETEREX
    /AWS1/CX_CGPNOTAUTHORIZEDEX
    /AWS1/CX_CGPRESOURCENOTFOUNDEX
    /AWS1/CX_CGPTOOMANYREQUESTSEX
    /AWS1/CX_CGPUSERNOTFOUNDEX
    /AWS1/CX_CGPCLIENTEXC
    /AWS1/CX_CGPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_username` `TYPE /AWS1/CGPUSERNAMETYPE` `/AWS1/CGPUSERNAMETYPE`¶

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

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

The ID of the user pool where you want to view a user's groups.

Optional arguments:¶

`iv_limit` `TYPE /AWS1/CGPQUERYLIMITTYPE` `/AWS1/CGPQUERYLIMITTYPE`¶

The maximum number of groups 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_cgpadminlstgrsforus01` `/AWS1/CL_CGPADMINLSTGRSFORUS01`¶

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->adminlistgroupsforuser(
  iv_limit = 123
  iv_nexttoken = |string|
  iv_username = |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_groups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_groupnametype = lo_row_1->get_groupname( ).
      lv_userpoolidtype = lo_row_1->get_userpoolid( ).
      lv_descriptiontype = lo_row_1->get_description( ).
      lv_arntype = lo_row_1->get_rolearn( ).
      lv_precedencetype = lo_row_1->get_precedence( ).
      lv_datetype = lo_row_1->get_lastmodifieddate( ).
      lv_datetype = lo_row_1->get_creationdate( ).
    ENDIF.
  ENDLOOP.
  lv_paginationkey = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_CGP=>ADMINLISTGROUPSFORUSER()¶