Profiles API Overview

Learn more about the Profiles API.

The profiles APIs allows you to assign profiles to your users.

To assign profiles, do the following:

  1. Retrieve the users in your tenant. For more information, see Users API.
  2. Retrieve all available profiles for your tenant. See v1/admin/profiles.
  3. Using the user ID and profile ID from the previous steps, assign a profile to a user. See v1/admin/profiles/{profile-id}/assign.

Example: Assign a profile to Jane

Let's say that you want to assign the profile Visier Analytics User to Jane Smith. To do so, you first retrieve Jane's user ID using the Users API. After you have her user ID, you can then get the profile ID for Visier Analytics User by retrieving all the profiles in your tenant using /v1/admin/profiles. After you have Jane's user ID and the Visier Analytics User profile ID, you can then assign the profile to Jane using /v1/admin/profiles/{profile-id}/assign.

Capabilities

A profile capability defines the actions users can perform in the studio experience. Capabilities set a user's access level and view level to different actions in the studio experience. All capabilities are disabled by default. Additional capabilities are either enabled or disabled. For more information about profile capabilities and additional capabilities, see Profile Capabilities.