Skip to content

/AWS1/IF_WDX=>UPDATEUSER()

About UpdateUser

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Method Signature

METHODS /AWS1/IF_WDX~UPDATEUSER
  IMPORTING
    !IV_AUTHENTICATIONTOKEN TYPE /AWS1/WDXAUTHNTCTNHEADERTYPE OPTIONAL
    !IV_USERID TYPE /AWS1/WDXIDTYPE OPTIONAL
    !IV_GIVENNAME TYPE /AWS1/WDXUSERATTRVALUETYPE OPTIONAL
    !IV_SURNAME TYPE /AWS1/WDXUSERATTRVALUETYPE OPTIONAL
    !IV_TYPE TYPE /AWS1/WDXUSERTYPE OPTIONAL
    !IO_STORAGERULE TYPE REF TO /AWS1/CL_WDXSTORAGERULETYPE OPTIONAL
    !IV_TIMEZONEID TYPE /AWS1/WDXTIMEZONEIDTYPE OPTIONAL
    !IV_LOCALE TYPE /AWS1/WDXLOCALETYPE OPTIONAL
    !IV_GRANTPOWERUSERPRIVILEGES TYPE /AWS1/WDXBOOLEANENUMTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wdxupdateuserresponse
  RAISING
    /AWS1/CX_WDXDEACTIVATINGLAST00
    /AWS1/CX_WDXENTITYNOTEXISTSEX
    /AWS1/CX_WDXFAILEDDEPENDENCYEX
    /AWS1/CX_WDXILLEGALUSERSTATEEX
    /AWS1/CX_WDXINVALIDARGUMENTEX
    /AWS1/CX_WDXPROHIBITEDSTATEEX
    /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

Required arguments:

iv_userid TYPE /AWS1/WDXIDTYPE /AWS1/WDXIDTYPE

The ID of the user.

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_givenname TYPE /AWS1/WDXUSERATTRVALUETYPE /AWS1/WDXUSERATTRVALUETYPE

The given name of the user.

iv_surname TYPE /AWS1/WDXUSERATTRVALUETYPE /AWS1/WDXUSERATTRVALUETYPE

The surname of the user.

iv_type TYPE /AWS1/WDXUSERTYPE /AWS1/WDXUSERTYPE

The type of the user.

io_storagerule TYPE REF TO /AWS1/CL_WDXSTORAGERULETYPE /AWS1/CL_WDXSTORAGERULETYPE

The amount of storage for the user.

iv_timezoneid TYPE /AWS1/WDXTIMEZONEIDTYPE /AWS1/WDXTIMEZONEIDTYPE

The time zone ID of the user.

iv_locale TYPE /AWS1/WDXLOCALETYPE /AWS1/WDXLOCALETYPE

The locale of the user.

iv_grantpoweruserprivileges TYPE /AWS1/WDXBOOLEANENUMTYPE /AWS1/WDXBOOLEANENUMTYPE

Boolean value to determine whether the user is granted Power user privileges.

RETURNING

oo_output TYPE REF TO /aws1/cl_wdxupdateuserresponse /AWS1/CL_WDXUPDATEUSERRESPONSE

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->updateuser(
  io_storagerule = new /aws1/cl_wdxstorageruletype(
    iv_storageallocatedinbytes = 123
    iv_storagetype = |string|
  )
  iv_authenticationtoken = |string|
  iv_givenname = |string|
  iv_grantpoweruserprivileges = |string|
  iv_locale = |string|
  iv_surname = |string|
  iv_timezoneid = |string|
  iv_type = |string|
  iv_userid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_user = lo_result->get_user( ).
  IF lo_user IS NOT INITIAL.
    lv_idtype = lo_user->get_id( ).
    lv_usernametype = lo_user->get_username( ).
    lv_emailaddresstype = lo_user->get_emailaddress( ).
    lv_userattributevaluetype = lo_user->get_givenname( ).
    lv_userattributevaluetype = lo_user->get_surname( ).
    lv_idtype = lo_user->get_organizationid( ).
    lv_resourceidtype = lo_user->get_rootfolderid( ).
    lv_resourceidtype = lo_user->get_recyclebinfolderid( ).
    lv_userstatustype = lo_user->get_status( ).
    lv_usertype = lo_user->get_type( ).
    lv_timestamptype = lo_user->get_createdtimestamp( ).
    lv_timestamptype = lo_user->get_modifiedtimestamp( ).
    lv_timezoneidtype = lo_user->get_timezoneid( ).
    lv_localetype = lo_user->get_locale( ).
    lo_userstoragemetadata = lo_user->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.
ENDIF.