SEARCHGROUPS()`¶

About SearchGroups¶

Searches the specified directory for a group. You can find groups that match the SearchString parameter with the value of their attributes included in the SearchString parameter.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the SearchGroups.NextToken member contains a token that you pass in the next call to SearchGroups. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

Method Signature¶

METHODS /AWS1/IF_DSD~SEARCHGROUPS
  IMPORTING
    !IV_DIRECTORYID TYPE /AWS1/DSDDIRECTORYID OPTIONAL
    !IV_SEARCHSTRING TYPE /AWS1/DSDSEARCHSTRING OPTIONAL
    !IT_SEARCHATTRIBUTES TYPE /AWS1/CL_DSDLDAPDSPNAMELIST_W=>TT_LDAPDISPLAYNAMELIST OPTIONAL
    !IV_REALM TYPE /AWS1/DSDREALM OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DSDNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DSDMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dsdsearchgroupsresult
  RAISING
    /AWS1/CX_DSDACCESSDENIEDEX
    /AWS1/CX_DSDDIRECTORYUNAVAILEX
    /AWS1/CX_DSDINTERNALSERVEREX
    /AWS1/CX_DSDTHROTTLINGEX
    /AWS1/CX_DSDVALIDATIONEX
    /AWS1/CX_DSDCLIENTEXC
    /AWS1/CX_DSDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_directoryid` `TYPE /AWS1/DSDDIRECTORYID` `/AWS1/DSDDIRECTORYID`¶

The identifier (ID) of the directory that's associated with the group.

`iv_searchstring` `TYPE /AWS1/DSDSEARCHSTRING` `/AWS1/DSDSEARCHSTRING`¶

The attribute value that you want to search for.

Wildcard (*) searches aren't supported. For a list of supported attributes, see Directory Service Data Attributes.

`it_searchattributes` `TYPE /AWS1/CL_DSDLDAPDSPNAMELIST_W=>TT_LDAPDISPLAYNAMELIST` `TT_LDAPDISPLAYNAMELIST`¶

One or more data attributes that are used to search for a group. For a list of supported attributes, see Directory Service Data Attributes.

Optional arguments:¶

`iv_realm` `TYPE /AWS1/DSDREALM` `/AWS1/DSDREALM`¶

The domain name that's associated with the group.

This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.

This value is case insensitive.

`iv_nexttoken` `TYPE /AWS1/DSDNEXTTOKEN` `/AWS1/DSDNEXTTOKEN`¶

An encoded paging token for paginated calls that can be passed back to retrieve the next page.

`iv_maxresults` `TYPE /AWS1/DSDMAXRESULTS` `/AWS1/DSDMAXRESULTS`¶

The maximum number of results to be returned per request.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dsdsearchgroupsresult` `/AWS1/CL_DSDSEARCHGROUPSRESULT`¶

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->searchgroups(
  it_searchattributes = VALUE /aws1/cl_dsdldapdspnamelist_w=>tt_ldapdisplaynamelist(
    ( new /aws1/cl_dsdldapdspnamelist_w( |string| ) )
  )
  iv_directoryid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_realm = |string|
  iv_searchstring = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_directoryid = lo_result->get_directoryid( ).
  lv_realm = lo_result->get_realm( ).
  LOOP AT lo_result->get_groups( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_sid = lo_row_1->get_sid( ).
      lv_groupname = lo_row_1->get_samaccountname( ).
      lv_distinguishedname = lo_row_1->get_distinguishedname( ).
      lv_grouptype = lo_row_1->get_grouptype( ).
      lv_groupscope = lo_row_1->get_groupscope( ).
      LOOP AT lo_row_1->get_otherattributes( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_stringattributevalue = lo_value->get_s( ).
          lv_numberattributevalue = lo_value->get_n( ).
          lv_booleanattributevalue = lo_value->get_bool( ).
          LOOP AT lo_value->get_ss( ) into lo_row_3.
            lo_row_4 = lo_row_3.
            IF lo_row_4 IS NOT INITIAL.
              lv_stringattributevalue = lo_row_4->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

To search for groups¶

The following command searches the examplecorp.com domain for groups with the GroupType security.

DATA(lo_result) = lo_client->searchgroups(
  it_searchattributes = VALUE /aws1/cl_dsdldapdspnamelist_w=>tt_ldapdisplaynamelist(
    ( new /aws1/cl_dsdldapdspnamelist_w( |GroupScope| ) )
  )
  iv_directoryid = |d-12233abcde|
  iv_maxresults = 123
  iv_nexttoken = |123456|
  iv_realm = |examplecorp.com|
  iv_searchstring = |Security|
).

/AWS1/IF_DSD=>SEARCHGROUPS()¶