Methods to manage multi-product users in an account.
Methods supported
| Method | Description |
|---|---|
| addDSGroup | POST /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroupsCreates a new DSGroup. |
| addDSGroupUsers | POST /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/usersAdds a list of users to a DSGroup. |
| addOrUpdateUser | POST /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/usersCreates or updates a multi-product user. |
| addUserProductPermissionProfiles | POST /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users/{userId}/permission_profilesAssigns permission profiles for a user by user ID. |
| addUserProductPermissionProfilesByEmail | POST /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles/usersAssigns permission profiles for a user by email address. |
| deleteDSGroup | DEL /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}Deletes a DSGroup. |
| getDSGroup | GET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}Returns details about a single DSGroup. |
| getDSGroups | GET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroupsReturns a list of DSGroups. |
| getDSGroupUsers | GET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/usersGets a list of users in a DSGroup. |
| getProductPermissionProfiles | GET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profilesGets products associated with the account and the available permission profiles. |
| getUserDSProfile | GET /Management/v2.1/organizations/{organizationId}/users/{userId}/dsprofileRetrieves the DS profile for a user specified by ID. |
| getUserDSProfilesByEmail | GET /Management/v2.1/organizations/{organizationId}/users/dsprofileRetrieves the DS profile for a user specified by email address. |
| getUserProductPermissionProfiles | GET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users/{userId}/permission_profilesRetrieves a user’s product permission profiles by user ID. |
| getUserProductPermissionProfilesByEmail | GET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles/usersRetrieves a user’s product permission profiles by email address. |
| removeDSGroupUsers | DEL /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/usersRemoves a list of users from a DSGroup. |
| removeUserProductPermission | DEL /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/usersRevokes a user’s access to one or more products. |
MultiProductUserManagement properties
| Property | Type | Description |
|---|---|---|
accounts | array of AddUserResponseAccountProperties | |
email | string | The email address. |
federated_status | string | The user’s federated status. One of: - RemoveStatus- FedAuthRequired- FedAuthBypass- Evicted |
first_name | string | The user’s first name. |
id | string (uuid) | |
language_culture | string | The language and culture of the user. - Chinese Simplified: zh_CN- Chinese Traditional: zh_TW- Dutch: nl- English: en- French: fr- German: de- Italian: it- Japanese: ja- Korean: ko- Portuguese: pt- Portuguese Brazil: pt_BR- Russian: ru- Spanish: es |
last_name | string | The user’s last name. |
site_id | integer (int32) | |
user_name | string | The full name of the user. |