Users API
Manage the 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, each person who accesses Visier needs a user account. Each user account is assigned different permissions and profiles that determine their data access and ability to use certain features in Visier. For more information about users and user groups, see User Management and User Groups.
Users V1
With version 1 of this API, you can:
- Add a new user
- Delete a user
- Make changes to existing user accounts
- Retrieve a user's details
- Retrieve a list of all users
- Assign permissions to users
- Remove permissions from users
- Retrieve a list of all permissions
- Retrieve all users that are assigned a specific permission
- Assign permissions to user groups
- Remove permissions from user groups
- Retrieve a list of user groups
- Retrieve all users assigned to a user group
- Add users to user groups
- Remove users from user groups
- Retrieve the Application Logs
- Retrieve the Data Security Report
Tip: If you submit API requests for changes that cause a project to publish to production, each request is individually published to production, resulting in hundreds or thousands of production versions. We recommend that you use the ProjectID request header to make changes in a project. For more information, see Projects API.
Users V2
Note: Limited Availability This feature is in limited availability. If you are interested, please contact your
With version 2 of the API, you can:
- Add new users in bulk
- Update users in bulk
- Delete users in bulk
User Groups V2
Note: Beta This API is in beta. While in beta, APIs are interface-stable and implementation may change without notice. Rarely, interface changes may occur that are not backwards-compatible and require advance communication. If you are interested in using this API, please contact your
With version 2 of the API, you can:
- Retrieve a list of all user groups
- Retrieve a user group's details
- Create new user groups in bulk
- Update user groups in bulk, such as changing the users and permissions assigned to a user group
- Delete user groups in bulk
Tip: If you submit API requests for changes that cause a project to publish to production, each request is individually published to production, resulting in hundreds or thousands of production versions. We recommend that you use the ProjectID request header to make changes in a project. For more information, see Projects API.
More security around data access management
Note: Limited Availability This feature is in limited availability. If you are interested, please contact your
Visier has also implemented additional safeguards that further limit who can manage permissions, change user groups, and preview as other users. We recommend that you turn on this feature to ensure administrators cannot access additional data or give themselves a higher access level than they have been assigned.
If this feature is enabled, administrators will need the Super Admin permission to perform the following actions:
- Assign permissions.
- Create and edit permissions.
- Create and edit user groups.
- Create and edit data access sets.
- Create and edit security filters.
- Preview the solution as a user.