Skip to content

/AWS1/IF_WKR=>LISTSECURITYGROUPUSERS()

About ListSecurityGroupUsers

Retrieves a paginated list of users who belong to a specific security group in a Wickr network.

Method Signature

METHODS /AWS1/IF_WKR~LISTSECURITYGROUPUSERS
  IMPORTING
    !IV_NETWORKID TYPE /AWS1/WKRNETWORKID OPTIONAL
    !IV_GROUPID TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/WKRINTEGER OPTIONAL
    !IV_SORTFIELDS TYPE /AWS1/WKRGENERICSTRING OPTIONAL
    !IV_SORTDIRECTION TYPE /AWS1/WKRSORTDIRECTION OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wkrlistsecgrpusersrsp
  RAISING
    /AWS1/CX_WKRBADREQUESTERROR
    /AWS1/CX_WKRFORBIDDENERROR
    /AWS1/CX_WKRINTSERVERERROR
    /AWS1/CX_WKRRATELIMITERROR
    /AWS1/CX_WKRRESNOTFOUNDERROR
    /AWS1/CX_WKRUNAUTHORIZEDERROR
    /AWS1/CX_WKRVALIDATIONERROR
    /AWS1/CX_WKRCLIENTEXC
    /AWS1/CX_WKRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_networkid TYPE /AWS1/WKRNETWORKID /AWS1/WKRNETWORKID

The ID of the Wickr network containing the security group.

iv_groupid TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING

The unique identifier of the security group whose users will be listed.

Optional arguments:

iv_nexttoken TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING

The token for retrieving the next page of results. This is returned from a previous request when there are more results available.

iv_maxresults TYPE /AWS1/WKRINTEGER /AWS1/WKRINTEGER

The maximum number of users to return in a single page. Valid range is 1-100. Default is 10.

iv_sortfields TYPE /AWS1/WKRGENERICSTRING /AWS1/WKRGENERICSTRING

The field to sort users by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', and 'lastName'.

iv_sortdirection TYPE /AWS1/WKRSORTDIRECTION /AWS1/WKRSORTDIRECTION

The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

RETURNING

oo_output TYPE REF TO /aws1/cl_wkrlistsecgrpusersrsp /AWS1/CL_WKRLISTSECGRPUSERSRSP

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->listsecuritygroupusers(
  iv_groupid = |string|
  iv_maxresults = 123
  iv_networkid = |string|
  iv_nexttoken = |string|
  iv_sortdirection = |string|
  iv_sortfields = |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_users( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_userid = lo_row_1->get_userid( ).
      lv_sensitivestring = lo_row_1->get_firstname( ).
      lv_sensitivestring = lo_row_1->get_lastname( ).
      lv_genericstring = lo_row_1->get_username( ).
      LOOP AT lo_row_1->get_securitygroups( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_securitygroupid = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_boolean = lo_row_1->get_isadmin( ).
      lv_boolean = lo_row_1->get_suspended( ).
      lv_integer = lo_row_1->get_status( ).
      lv_boolean = lo_row_1->get_otpenabled( ).
      lv_genericstring = lo_row_1->get_scimid( ).
      lv_genericstring = lo_row_1->get_type( ).
      lv_genericstring = lo_row_1->get_cell( ).
      lv_genericstring = lo_row_1->get_countrycode( ).
      lv_integer = lo_row_1->get_challengefailures( ).
      lv_boolean = lo_row_1->get_isinviteexpired( ).
      lv_boolean = lo_row_1->get_isuser( ).
      lv_genericstring = lo_row_1->get_invitecode( ).
      lv_boolean = lo_row_1->get_codevalidation( ).
      lv_genericstring = lo_row_1->get_uname( ).
    ENDIF.
  ENDLOOP.
  lv_genericstring = lo_result->get_nexttoken( ).
ENDIF.

List security group users with pagination

List security group users with pagination

DATA(lo_result) = lo_client->listsecuritygroupusers(
  iv_groupid = |abc12345|
  iv_maxresults = 10
  iv_networkid = |12345678|
  iv_sortdirection = |ASC|
  iv_sortfields = |username|
).