ALalianza
Account User

Get user list

Use to retrieve a list of <a href="#/~schema/AccountUserX">Account Users </a>. The limitedData query parameter is provided to enable large result sets to be retrieved.

get/v2/partition/{partitionId}/account/{accountId}/accountuser

Request

Path parameters

accountIdstring required

ID of account, refers to <a href="#/~schema/Account">account.id</a>

partitionIdstring required

ID of partition, refers to <a href="#/~schema/PartitionX">partition.id</a>

Query parameters

limitedDataboolean

Set limitedData to true to enable the retrieval of all users in a single call. If set to false, a maximum of 1000 users will be retrieved.

Response

Successful operation

partitionIdstring

A partitionId identifies the business entity that this account is a part of. Refers to <a href="#/~schema/PartitionX">partition.id</a>

accountIdstring

ID of account, refers to <a href="#/~schema/Account">account.id</a>

userIdstring

Identifies a unique Account User.

subDomainstring

Determines the branding which is used in the display of user emails and the portal. Must exist in the <a href="#/~operation/Partition/getAllSettings">Partition Settings</a> (type SUB-DOMAINS).

usernamestring required

The email address of the AccountUser.

firstNamestring required
lastNamestring required
mustChangePasswordboolean

Indicates whether the user will be required to update their password upon login. This field cannot be set manually, only read out.

languageTagstring

The localization setting that indicates the language of the user. Example: "en-US"

idstring

The same value as the userId.

Changes

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