LISTUSERS()`¶

About ListUsers¶

Returns user information for the specified directory.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListUsers.NextToken member contains a token that you pass in the next call to ListUsers. 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~LISTUSERS
  IMPORTING
    !IV_DIRECTORYID TYPE /AWS1/DSDDIRECTORYID 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_dsdlistusersresult
  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 user.

Optional arguments:¶

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

The domain name that's associated with the user.

This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users 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_dsdlistusersresult` `/AWS1/CL_DSDLISTUSERSRESULT`¶

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->listusers(
  iv_directoryid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_realm = |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_users( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_sid = lo_row_1->get_sid( ).
      lv_username = lo_row_1->get_samaccountname( ).
      lv_givenname = lo_row_1->get_givenname( ).
      lv_surname = lo_row_1->get_surname( ).
      lv_boolean = lo_row_1->get_enabled( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

To list users in a realm¶

The following command lists users on the examplecorp.com domain.

DATA(lo_result) = lo_client->listusers(
  iv_directoryid = |d-12233abcde|
  iv_realm = |examplecorp.com|
).

/AWS1/IF_DSD=>LISTUSERS()¶