Skip to content

/AWS1/IF_IDS=>LISTGROUPMEMBERSHIPS()

About ListGroupMemberships

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Method Signature

METHODS /AWS1/IF_IDS~LISTGROUPMEMBERSHIPS
  IMPORTING
    !IV_IDENTITYSTOREID TYPE /AWS1/IDSIDENTITYSTOREID OPTIONAL
    !IV_GROUPID TYPE /AWS1/IDSRESOURCEID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/IDSMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/IDSNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_idslstgrmemberships03
  RAISING
    /AWS1/CX_IDSACCESSDENIEDEX
    /AWS1/CX_IDSINTERNALSERVEREX
    /AWS1/CX_IDSTHROTTLINGEX
    /AWS1/CX_IDSRESOURCENOTFOUNDEX
    /AWS1/CX_IDSVALIDATIONEX
    /AWS1/CX_IDSCLIENTEXC
    /AWS1/CX_IDSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_identitystoreid TYPE /AWS1/IDSIDENTITYSTOREID /AWS1/IDSIDENTITYSTOREID

The globally unique identifier for the identity store.

iv_groupid TYPE /AWS1/IDSRESOURCEID /AWS1/IDSRESOURCEID

The identifier for a group in the identity store.

Optional arguments:

iv_maxresults TYPE /AWS1/IDSMAXRESULTS /AWS1/IDSMAXRESULTS

The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.

iv_nexttoken TYPE /AWS1/IDSNEXTTOKEN /AWS1/IDSNEXTTOKEN

The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

RETURNING

oo_output TYPE REF TO /aws1/cl_idslstgrmemberships03 /AWS1/CL_IDSLSTGRMEMBERSHIPS03

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->listgroupmemberships(
  iv_groupid = |string|
  iv_identitystoreid = |string|
  iv_maxresults = 123
  iv_nexttoken = |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_groupmemberships( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_identitystoreid = lo_row_1->get_identitystoreid( ).
      lv_resourceid = lo_row_1->get_membershipid( ).
      lv_resourceid = lo_row_1->get_groupid( ).
      lo_memberid = lo_row_1->get_memberid( ).
      IF lo_memberid IS NOT INITIAL.
        lv_resourceid = lo_memberid->get_userid( ).
      ENDIF.
      lv_datetype = lo_row_1->get_createdat( ).
      lv_datetype = lo_row_1->get_updatedat( ).
      lv_stringtype = lo_row_1->get_createdby( ).
      lv_stringtype = lo_row_1->get_updatedby( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.