Skip to navigation

MultiProductUserManagement Resource

View as Markdown

Methods to manage multi-product users in an account.

Methods supported

MethodDescription
addDSGroupPOST /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups
Creates a new DSGroup.
addDSGroupUsersPOST /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users
Adds a list of users to a DSGroup.
addOrUpdateUserPOST /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/users
Creates or updates a multi-product user.
addUserProductPermissionProfilesPOST /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users/{userId}/permission_profiles
Assigns permission profiles for a user by user ID.
addUserProductPermissionProfilesByEmailPOST /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles/users
Assigns permission profiles for a user by email address.
deleteDSGroupDEL /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}
Deletes a DSGroup.
getDSGroupGET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}
Returns details about a single DSGroup.
getDSGroupsGET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups
Returns a list of DSGroups.
getDSGroupUsersGET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users
Gets a list of users in a DSGroup.
getProductPermissionProfilesGET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles
Gets products associated with the account and the available permission profiles.
getUserDSProfileGET /Management/v2.1/organizations/{organizationId}/users/{userId}/dsprofile
Retrieves the DS profile for a user specified by ID.
getUserDSProfilesByEmailGET /Management/v2.1/organizations/{organizationId}/users/dsprofile
Retrieves the DS profile for a user specified by email address.
getUserProductPermissionProfilesGET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users/{userId}/permission_profiles
Retrieves a user’s product permission profiles by user ID.
getUserProductPermissionProfilesByEmailGET /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/permission_profiles/users
Retrieves a user’s product permission profiles by email address.
removeDSGroupUsersDEL /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/dsgroups/{dsGroupId}/users
Removes a list of users from a DSGroup.
removeUserProductPermissionDEL /Management/v2.1/organizations/{organizationId}/accounts/{accountId}/products/users
Revokes a user’s access to one or more products.

MultiProductUserManagement properties

PropertyTypeDescription
accountsarray of AddUserResponseAccountProperties
emailstringThe email address.
federated_statusstringThe user’s federated status. One of:

- RemoveStatus
- FedAuthRequired
- FedAuthBypass
- Evicted
first_namestringThe user’s first name.
idstring (uuid)
language_culturestringThe 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_namestringThe user’s last name.
site_idinteger (int32)
user_namestringThe full name of the user.