/AWS1/CL_IDS=>LISTGROUPS()

About ListGroups

Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Method Signature

IMPORTING

Required arguments:

iv_identitystoreid TYPE /AWS1/IDSIDENTITYSTOREID /AWS1/IDSIDENTITYSTOREID

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

Optional arguments:

iv_maxresults TYPE /AWS1/IDSMAXRESULTS /AWS1/IDSMAXRESULTS

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

iv_nexttoken TYPE /AWS1/IDSNEXTTOKEN /AWS1/IDSNEXTTOKEN

The pagination token used for the ListUsers and ListGroups 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.

it_filters TYPE /AWS1/CL_IDSFILTER=>TT_FILTERS TT_FILTERS

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

RETURNING

oo_output TYPE REF TO /aws1/cl_idslistgroupsresponse /AWS1/CL_IDSLISTGROUPSRESPONSE

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->/aws1/if_ids~listgroups(
  it_filters = VALUE /aws1/cl_idsfilter=>tt_filters(
    (
      new /aws1/cl_idsfilter(
        iv_attributepath = |string|
        iv_attributevalue = |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_groups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_resourceid = lo_row_1->get_groupid( ).
      lv_groupdisplayname = lo_row_1->get_displayname( ).
      LOOP AT lo_row_1->get_externalids( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_externalidissuer = lo_row_3->get_issuer( ).
          lv_externalididentifier = lo_row_3->get_id( ).
        ENDIF.
      ENDLOOP.
      lv_sensitivestringtype = lo_row_1->get_description( ).
      lv_identitystoreid = lo_row_1->get_identitystoreid( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.