Profiles API
Manage the profiles assigned to your Visier users.
Who can use this feature?
To use the APIs, you must have a Visier account with a profile that has the API capability. If you don't have an account, contact your administrator. They will create an account for you with permissions that allow you to view data.
Not sure if you have this feature or capability? Reach out to your administrator.
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.
To specify a single tenant to manage profiles in, use TargetTenantID. To manage profiles for many tenants in the same request, use tenantCode.
- The TargetTenantID request 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 tenantCode parameter defines the tenant to make changes to. In APIs that support many tenant codes, specify each tenantCode and omit TargetTenantID.
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.