Management User

Create a management user

Use to create a management user, which sends an invite email to the person in preparation for their first login to the admin portal. <span hidden>For more information on creating management users, see the <a href="managementUser.html#createManagementUser">create Management User</a> documentation.</span>

post/v2/partition/{partitionId}/managementuser

Request

Path parameters

partitionIdstring required

ID of partition this managementUser will be created under. Refers to <a href="#/~schema/PartitionX">partition.id</a>

Request body

idstring
usernamestring

users email address

firstNamestring
lastNamestring
emailAddressstring

just a readonly repetition of the username

mustChangePasswordboolean
languageTag'en-US' | 'fr-CA'
partitionIdstring

Reference to <a href="#/~schema/PartitionX">PartitionX.id</a>

rolesstring[]

A list of roles that the contain the permissions of this managementUser.

groupIdsstring[]

Readonly and internal only, the same information is contained in the roles array in a different format

Response

Successful operation

idstring
usernamestring

users email address

firstNamestring
lastNamestring
emailAddressstring

just a readonly repetition of the username

mustChangePasswordboolean
languageTag'en-US' | 'fr-CA'
partitionIdstring

Reference to <a href="#/~schema/PartitionX">PartitionX.id</a>

rolesstring[]

A list of roles that the contain the permissions of this managementUser.

groupIdsstring[]

Readonly and internal only, the same information is contained in the roles array in a different format

Changes

No recorded changes to this operation across all 1 revision of this API.