Updates data for the user¶

Description¶

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

Usage¶

workmail_update_user(OrganizationId, UserId, Role, DisplayName,
  FirstName, LastName, HiddenFromGlobalAddressList, Initials, Telephone,
  Street, JobTitle, City, Company, ZipCode, Department, Country, Office,
  IdentityProviderUserId)

Arguments¶

• OrganizationId

  [required] The identifier for the organization under which the user exists.

• UserId

  [required] 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

• Role

  Updates the user role.

  You cannot pass SYSTEM_USER or RESOURCE.

• DisplayName

  Updates the display name of the user.

• FirstName

  Updates the user's first name.

• LastName

  Updates the user's last name.

• HiddenFromGlobalAddressList

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

• Initials

  Updates the user's initials.

• Telephone

  Updates the user's contact details.

• Street

  Updates the user's street address.

• JobTitle

  Updates the user's job title.

• City

  Updates the user's city.

• Company

  Updates the user's company.

• ZipCode

  Updates the user's zip code.

• Department

  Updates the user's department.

• Country

  Updates the user's country.

• Office

  Updates the user's office.

• IdentityProviderUserId

  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.

Value¶

An empty list.

Request syntax¶

svc$update_user(
  OrganizationId = "string",
  UserId = "string",
  Role = "USER"|"RESOURCE"|"SYSTEM_USER"|"REMOTE_USER",
  DisplayName = "string",
  FirstName = "string",
  LastName = "string",
  HiddenFromGlobalAddressList = TRUE|FALSE,
  Initials = "string",
  Telephone = "string",
  Street = "string",
  JobTitle = "string",
  City = "string",
  Company = "string",
  ZipCode = "string",
  Department = "string",
  Country = "string",
  Office = "string",
  IdentityProviderUserId = "string"
)