Create User

workmail_create_user

R Documentation

Creates a user who can be used in WorkMail by calling the RegisterToWorkMail operation¶

Description¶

Creates a user who can be used in WorkMail by calling the register_to_work_mail operation.

Usage¶

workmail_create_user(OrganizationId, Name, DisplayName, Password, Role,
  FirstName, LastName, HiddenFromGlobalAddressList)

Arguments¶

OrganizationId

[required] The identifier of the organization for which the user is created.

Name

[required] The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum length of 20.

DisplayName

[required] The display name for the new user.

Password

The password for the new user.

Role

The role of the new user.

You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected, the default role of USER is selected.

FirstName

The first name of the new user.

LastName

The last name of the new user.

HiddenFromGlobalAddressList

If this parameter is enabled, the user will be hidden from the address book.

Value¶

A list with the following syntax:

list(
  UserId = "string"
)

Request syntax¶

svc$create_user(
  OrganizationId = "string",
  Name = "string",
  DisplayName = "string",
  Password = "string",
  Role = "USER"|"RESOURCE"|"SYSTEM_USER"|"REMOTE_USER",
  FirstName = "string",
  LastName = "string",
  HiddenFromGlobalAddressList = TRUE|FALSE
)