Reseller Users Overview #
The Account Users resource allows for the management of users at reseller level. The base URI for all request is:
/{VERSION}/accounts/{ACCOUNT_TENANT_ID}/users/{USER_ID}
Reseller Users Schema #
Users represent an end user of the system.
| Key | Description | Type | Default | Required |
|---|---|---|---|---|
| id | The unique User identifier | string | (auto generated) | Yes (not create) |
| displayName | A full User display name | string[100] | Yes | |
| The email address of the User | string[200] | Yes | ||
| roles | Collection of roles | roles | ||
| primaryTenant | The id of the Users primary tenant | string |
Roles #
Permission Roles #
These control the user's permissions and the areas which they can access.
| Key | UI Name | Description |
|---|---|---|
| account.user | Reseller Website Access | Grants the user access to the reseller web portal. |
| user.admin | Manage Users | Allows the user manager other Reseller Portal user permissions. |
| account.service.status | Status Updates | Subscribes the user to platform status updates and release notes |
| account.storage.admin | Storage Administrator | Allows the user to create and manage storage accounts. |
| branding.admin | Branding Administrator | Allows the user to modify the branding for all applicable portals. |
| customer.admin | Customer Administrator | Allows the user to create and manage customer accounts. |
| onboarding.admin | REST API Administrator | Allows the user to login into the Reseller Portal. |
| webhooks.admin | Webhook Administrator | Allows the user to configure the REST API service. |
Available Interfaces #
| Interface | Description |
|---|---|
| Get All | Returns a collection of all account users. |
| Get User | Returns a specific account user instance. |
| Create User | Creates a new account user instance. |
| Patch User | Updates an existing account user instance. |
| Delete User | Removes an existing account user instance. |
| Send Activation Email | Sends the account user an activation email link so they can authenticate with the system. |