Skip to content

/AWS1/IF_WML=>UPDATEUSER()

About UpdateUser

Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another DescribeUser call.

Method Signature

METHODS /AWS1/IF_WML~UPDATEUSER
  IMPORTING
    !IV_ORGANIZATIONID TYPE /AWS1/WMLORGANIZATIONID OPTIONAL
    !IV_USERID TYPE /AWS1/WMLENTITYIDENTIFIER OPTIONAL
    !IV_ROLE TYPE /AWS1/WMLUSERROLE OPTIONAL
    !IV_DISPLAYNAME TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_FIRSTNAME TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_LASTNAME TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_HIDDENFROMGLBADDRESSLIST TYPE /AWS1/WMLBOOLEANOBJECT OPTIONAL
    !IV_INITIALS TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_TELEPHONE TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_STREET TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_JOBTITLE TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_CITY TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_COMPANY TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_ZIPCODE TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_DEPARTMENT TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_COUNTRY TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_OFFICE TYPE /AWS1/WMLUSERATTRIBUTE OPTIONAL
    !IV_IDENTITYPROVIDERUSERID TYPE /AWS1/WMLIDPVDRUSERIDFORUPDATE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_wmlupdateuserresponse
  RAISING
    /AWS1/CX_WMLDIRECTORYSVCAUTH00
    /AWS1/CX_WMLDIRECTORYUNAVAILEX
    /AWS1/CX_WMLENTITYNOTFOUNDEX
    /AWS1/CX_WMLENTITYSTATEEX
    /AWS1/CX_WMLINVALIDPARAMETEREX
    /AWS1/CX_WMLORGNOTFOUNDEX
    /AWS1/CX_WMLORGSTATEEXCEPTION
    /AWS1/CX_WMLUNSUPPORTEDOPEX
    /AWS1/CX_WMLCLIENTEXC
    /AWS1/CX_WMLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_organizationid TYPE /AWS1/WMLORGANIZATIONID /AWS1/WMLORGANIZATIONID

The identifier for the organization under which the user exists.

iv_userid TYPE /AWS1/WMLENTITYIDENTIFIER /AWS1/WMLENTITYIDENTIFIER

The identifier for the user to be updated.

The identifier can be the UserId, Username, or email. The following identity formats are available:

  • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: user@domain.tld

  • User name: user

Optional arguments:

iv_role TYPE /AWS1/WMLUSERROLE /AWS1/WMLUSERROLE

Updates the user role.

You cannot pass SYSTEM_USER or RESOURCE.

iv_displayname TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the display name of the user.

iv_firstname TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's first name.

iv_lastname TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's last name.

iv_hiddenfromglbaddresslist TYPE /AWS1/WMLBOOLEANOBJECT /AWS1/WMLBOOLEANOBJECT

If enabled, the user is hidden from the global address list.

iv_initials TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's initials.

iv_telephone TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's contact details.

iv_street TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's street address.

iv_jobtitle TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's job title.

iv_city TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's city.

iv_company TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's company.

iv_zipcode TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's zip code.

iv_department TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's department.

iv_country TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's country.

iv_office TYPE /AWS1/WMLUSERATTRIBUTE /AWS1/WMLUSERATTRIBUTE

Updates the user's office.

iv_identityprovideruserid TYPE /AWS1/WMLIDPVDRUSERIDFORUPDATE /AWS1/WMLIDPVDRUSERIDFORUPDATE

User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

RETURNING

oo_output TYPE REF TO /aws1/cl_wmlupdateuserresponse /AWS1/CL_WMLUPDATEUSERRESPONSE

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(
  iv_city = |string|
  iv_company = |string|
  iv_country = |string|
  iv_department = |string|
  iv_displayname = |string|
  iv_firstname = |string|
  iv_hiddenfromglbaddresslist = ABAP_TRUE
  iv_identityprovideruserid = |string|
  iv_initials = |string|
  iv_jobtitle = |string|
  iv_lastname = |string|
  iv_office = |string|
  iv_organizationid = |string|
  iv_role = |string|
  iv_street = |string|
  iv_telephone = |string|
  iv_userid = |string|
  iv_zipcode = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.