Tenants API
Manage your analytic tenants, such as retrieving information, validating metric values, and creating or disabling tenants.
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, tenants represent an organization. There are two types of tenant: administrating tenants and analytic tenants.
An administrating tenant manages one or more analytic tenants. Administrating tenants are capable of creating further analytic tenants and navigating to existing analytic tenants to support them.
An analytic tenant represents an organization associated with an instance of Visier that has loaded a solution such as Visier People. Each tenant has a unique code and a user-friendly display name. If you are responsible for one tenant, you are an analytic tenant.
For more information about tenants, see Tenant Management.
Visier supports two versions of tenants API. If you're already using version 1 and want to start using version 2 endpoints, see Switch to Version 2 of the Tenants API.
With version 1, you can:
- Create new tenants
- Enable or disable existing tenants
- Delete (deprovision) tenants
- Update a tenant
- Retrieve a list of all tenants
- Retrieve the details of a specific tenant
- Validate metric values for all tenants or a specific tenant
With version 2, you can:
- Create new tenants
- Update a tenant
- Retrieve a list of all tenants
- Retrieve the details of a specific tenant
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 make many project changes in a single API request to:
- Generate fewer production versions.
- Improve API performance.
- Reduce the impact on your API rate limit.