Profiles API
Manage the profiles assigned to your Visier users.
Access requirements
To use APIs, you must have a Visier account. If you don't have an account, contact your administrator. To authenticate with Visier APIs, use OAuth 2.0 or basic authentication. For more information, see API Authentication.
Custom profiles with one of the following capability sets:
- Profile Management (Read, API) or User Management (Read, API)
- Profile Management (Write, API) or User Management (Write, API) required for creating, updating, and deleting
Reach out to your administrator for access.
Overview
In Visier, administrative users are assigned "profiles". You can think of these as something akin to a user role: the profile describes the functional capability a user may have. For more information about profiles, see Studio Profiles.
Administrating tenants can perform actions on a single tenant using TargetTenantID or on multiple tenants in the same request using tenantCode.
- The
TargetTenantIDrequest header defines the tenant that you're logged into. If defined, the API call executes from the specified tenant. If omitted, the default is the administrating tenant. - The
tenantCodeparameter defines the tenant to make changes to. In APIs that support many tenant codes, specify eachtenantCodeand omitTargetTenantID.
For more information about whether TargetTenantID or tenantCode is supported in an endpoint, see API Reference.
With this API, you can:
- Retrieve all profiles in your tenant.
- Retrieve all profiles for a specific user.
- Retrieve information about a specific profile.
- Assign a profile to a list of users.
- Remove a profile from a list of users.