Skip to content

Describe User

workmail_describe_user R Documentation

Provides information regarding the user

Description

Provides information regarding the user.

Usage

workmail_describe_user(OrganizationId, UserId)

Arguments

OrganizationId

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

UserId

[required] The identifier for the user to be described.

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

Value

A list with the following syntax: 

list(
  UserId = "string",
  Name = "string",
  Email = "string",
  DisplayName = "string",
  State = "ENABLED"|"DISABLED"|"DELETED",
  UserRole = "USER"|"RESOURCE"|"SYSTEM_USER"|"REMOTE_USER",
  EnabledDate = as.POSIXct(
    "2015-01-01"
  ),
  DisabledDate = as.POSIXct(
    "2015-01-01"
  ),
  MailboxProvisionedDate = as.POSIXct(
    "2015-01-01"
  ),
  MailboxDeprovisionedDate = as.POSIXct(
    "2015-01-01"
  ),
  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"
)

Request syntax

svc$describe_user(
  OrganizationId = "string",
  UserId = "string"
)