Skip to content

/AWS1/IF_WDX=>DESCRIBEUSERS()

About DescribeUsers

Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.

Method Signature

METHODS /AWS1/IF_WDX~DESCRIBEUSERS
  IMPORTING
    !IV_AUTHENTICATIONTOKEN TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE OPTIONAL
    !IV_ORGANIZATIONID TYPE /AWS1/WDXIDTYPE OPTIONAL
    !IV_USERIDS TYPE /AWS1/WDXUSERIDSTYPE OPTIONAL
    !IV_QUERY TYPE /AWS1/WDXSEARCHQUERYTYPE OPTIONAL
    !IV_INCLUDE TYPE /AWS1/WDXUSERFILTERTYPE OPTIONAL
    !IV_ORDER TYPE /AWS1/WDXORDERTYPE OPTIONAL
    !IV_SORT TYPE /AWS1/WDXUSERSORTTYPE OPTIONAL
    !IV_MARKER TYPE /AWS1/WDXPAGEMARKERTYPE OPTIONAL
    !IV_LIMIT TYPE /AWS1/WDXLIMITTYPE OPTIONAL
    !IV_FIELDS TYPE /AWS1/WDXFIELDNAMESTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wdxdescrusersresponse
  RAISING
    /AWS1/CX_WDXENTITYNOTEXISTSEX
    /AWS1/CX_WDXFAILEDDEPENDENCYEX
    /AWS1/CX_WDXINVALIDARGUMENTEX
    /AWS1/CX_WDXREQEDENTTOOLARGEEX
    /AWS1/CX_WDXSERVICEUNAVAILEX
    /AWS1/CX_WDXUNAUTHDOPERATIONEX
    /AWS1/CX_WDXUNAUTHDRESRCACCEX
    /AWS1/CX_WDXCLIENTEXC
    /AWS1/CX_WDXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_authenticationtoken TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE /AWS1/WDXAUTHNTCTNHEADERTYPE

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

iv_organizationid TYPE /AWS1/WDXIDTYPE /AWS1/WDXIDTYPE

The ID of the organization.

iv_userids TYPE /AWS1/WDXUSERIDSTYPE /AWS1/WDXUSERIDSTYPE

The IDs of the users.

iv_query TYPE /AWS1/WDXSEARCHQUERYTYPE /AWS1/WDXSEARCHQUERYTYPE

A query to filter users by user name. Remember the following about the Userids and Query parameters:

  • If you don't use either parameter, the API returns a paginated list of all users on the site.

  • If you use both parameters, the API ignores the Query parameter.

  • The Userid parameter only returns user names that match a corresponding user ID.

  • The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson.

iv_include TYPE /AWS1/WDXUSERFILTERTYPE /AWS1/WDXUSERFILTERTYPE

The state of the users. Specify "ALL" to include inactive users.

iv_order TYPE /AWS1/WDXORDERTYPE /AWS1/WDXORDERTYPE

The order for the results.

iv_sort TYPE /AWS1/WDXUSERSORTTYPE /AWS1/WDXUSERSORTTYPE

The sorting criteria.

iv_marker TYPE /AWS1/WDXPAGEMARKERTYPE /AWS1/WDXPAGEMARKERTYPE

The marker for the next set of results. (You received this marker from a previous call.)

iv_limit TYPE /AWS1/WDXLIMITTYPE /AWS1/WDXLIMITTYPE

The maximum number of items to return.

iv_fields TYPE /AWS1/WDXFIELDNAMESTYPE /AWS1/WDXFIELDNAMESTYPE

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

RETURNING

oo_output TYPE REF TO /aws1/cl_wdxdescrusersresponse /AWS1/CL_WDXDESCRUSERSRESPONSE

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->describeusers(
  iv_authenticationtoken = |string|
  iv_fields = |string|
  iv_include = |string|
  iv_limit = 123
  iv_marker = |string|
  iv_order = |string|
  iv_organizationid = |string|
  iv_query = |string|
  iv_sort = |string|
  iv_userids = |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_idtype = lo_row_1->get_id( ).
      lv_usernametype = lo_row_1->get_username( ).
      lv_emailaddresstype = lo_row_1->get_emailaddress( ).
      lv_userattributevaluetype = lo_row_1->get_givenname( ).
      lv_userattributevaluetype = lo_row_1->get_surname( ).
      lv_idtype = lo_row_1->get_organizationid( ).
      lv_resourceidtype = lo_row_1->get_rootfolderid( ).
      lv_resourceidtype = lo_row_1->get_recyclebinfolderid( ).
      lv_userstatustype = lo_row_1->get_status( ).
      lv_usertype = lo_row_1->get_type( ).
      lv_timestamptype = lo_row_1->get_createdtimestamp( ).
      lv_timestamptype = lo_row_1->get_modifiedtimestamp( ).
      lv_timezoneidtype = lo_row_1->get_timezoneid( ).
      lv_localetype = lo_row_1->get_locale( ).
      lo_userstoragemetadata = lo_row_1->get_storage( ).
      IF lo_userstoragemetadata IS NOT INITIAL.
        lv_sizetype = lo_userstoragemetadata->get_storageutilizedinbytes( ).
        lo_storageruletype = lo_userstoragemetadata->get_storagerule( ).
        IF lo_storageruletype IS NOT INITIAL.
          lv_positivesizetype = lo_storageruletype->get_storageallocatedinbytes( ).
          lv_storagetype = lo_storageruletype->get_storagetype( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_sizetype = lo_result->get_totalnumberofusers( ).
  lv_pagemarkertype = lo_result->get_marker( ).
ENDIF.