@aws-sdk/client-workmail

CreateUserCommandInput Interface

The input for CreateUserCommand.

Members

Name
Type
Details
DisplayName Requiredstring | undefined

The display name for the new user.

Name Requiredstring | undefined

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

OrganizationId Requiredstring | undefined

The identifier of the organization for which the user is created.

FirstName string | undefined

The first name of the new user.

HiddenFromGlobalAddressList boolean | undefined

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

IdentityProviderUserId string | undefined

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.

LastName string | undefined

The last name of the new user.

Password string | undefined

The password for the new user.

Role UserRole | undefined

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.

Full Signature

export interface CreateUserCommandInput extends CreateUserRequest