openapi: 3.2.0
info:
title: Visier Administration Consolidated Analytics API
description: Visier APIs for managing your tenant or tenants in Visier. You can programmatically manage user accounts in Visier, the profiles and permissions assigned to users, and to make changes in projects and publish projects to production. Administrating tenant users can use administration APIs to manage their analytic tenants and consolidated analytics tenants.<br>**Note:** If you submit API requests for changes that cause a project to publish to production (such as assigning permissions to users or updating permissions), 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, if `ProjectID` is available for the API endpoint.
license:
name: Apache License, Version 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: 22222222.99201.3040
security:
- ApiKeyAuth: []
BearerAuth: []
- ApiKeyAuth: []
CookieAuth: []
- ApiKeyAuth: []
OAuth2Auth: []
tags:
- name: ConsolidatedAnalytics
x-displayName: Consolidated Analytics
description: 'Manage your consolidated analytics (CA) tenants in Visier, such as retrieving the details of CA tenants, creating CA tenants, adding or deleting source tenants from CA tenants, and excluding sources from CA tenants.
<br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.
If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>'
paths:
/v1alpha/admin/consolidated-analytics/tenants:
get:
tags:
- ConsolidatedAnalytics
summary: Retrieve a list of all consolidated analytics tenants
description: "Retrieve the full list of consolidated analytics tenants in your administrating tenant.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: ConsolidatedAnalytics_ListTenants
parameters:
- name: limit
in: query
description: The maximum number of tenants to return. The maximum value is 1000. Default is 400.
schema:
type: integer
format: int32
- name: start
in: query
description: The starting index of the first tenant to return. Default is 0.
schema:
type: integer
format: int32
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPITenantListResponseDTO'
post:
tags:
- ConsolidatedAnalytics
summary: Create a consolidated analytics tenant
description: "Create a consolidated analytics tenant.\n\n A new CA tenant has no source tenants and no excluded sources.\n\n **Note:** CA tenant codes must have a prefix of CA. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY}\n is the consolidated analytic tenant code.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: ConsolidatedAnalytics_CreateTenant
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPITenantCreateRequestDTO'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPITenantCreateRequestDTO'
/v1alpha/admin/consolidated-analytics/tenants-with-details:
get:
tags:
- ConsolidatedAnalytics
summary: Retrieve the details of all consolidated analytics tenants
description: "Retrieve the full list of consolidated analytics tenants and their details in your administrating tenant.\n\n **Note:** If your consolidated analytics tenants have thousands of source tenants, we recommend that you use the `GET /admin/consolidated-analytics/tenants` endpoint to get all CA tenants and then use the `GET /admin/consolidated-analytics/tenants/{tenantId}/source-tenants` and `GET /admin/consolidated-analytics/tenants/{tenantId}/excluded-sources` endpoints to retrieve information about specific CA tenants.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: ConsolidatedAnalytics_ListTenantsWithDetails
parameters:
- name: limit
in: query
description: The maximum number of tenants to return. The maximum value is 1000. Default is 400.
schema:
type: integer
format: int32
- name: start
in: query
description: The starting index of the first tenant to return. Default is 0.
schema:
type: integer
format: int32
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO'
/v1alpha/admin/consolidated-analytics/tenants/{tenantId}/excluded-sources:
get:
tags:
- ConsolidatedAnalytics
summary: Retrieve a consolidated analytics tenant's excluded sources
description: "Retrieve a CA tenant's excluded sources.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: ConsolidatedAnalytics_ListExcludedSources
parameters:
- name: tenantId
in: path
description: "The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY}\n is the consolidated analytic tenant code."
required: true
schema:
type: string
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPIExcludedSourceListDTO'
put:
tags:
- ConsolidatedAnalytics
summary: Set a consolidated analytics tenant's excluded sources
description: "Define the excluded sources for a consolidated analytics tenant.\n\n After you create a CA tenant, you may optionally define a list of excluded sources. The excluded sources are the sources whose data is excluded from the CA tenant.\n You can also use this API to replace the list of excluded sources for an existing CA tenant.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: ConsolidatedAnalytics_SetExcludedSources
parameters:
- name: tenantId
in: path
description: "The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY}\n is the consolidated analytic tenant code."
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ExcludedSourcesBody'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPIExcludedSourceListDTO'
delete:
tags:
- ConsolidatedAnalytics
summary: Remove excluded sources from a consolidated analytics tenants
description: "Remove excluded sources from the list of excluded sources for a consolidated analytics tenant.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: ConsolidatedAnalytics_RemoveExcludedSources
parameters:
- name: tenantId
in: path
description: "The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY}\n is the consolidated analytic tenant code."
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ExcludedSourcesBody'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPIExcludedSourceListDTO'
patch:
tags:
- ConsolidatedAnalytics
summary: Add excluded sources to a consolidated analytics tenant
description: "Add excluded sources to the list of excluded sources for a consolidated analytics tenant.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: ConsolidatedAnalytics_AddExcludedSources
parameters:
- name: tenantId
in: path
description: "The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY}\n is the consolidated analytic tenant code."
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ExcludedSourcesBody'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPIExcludedSourceListDTO'
/v1alpha/admin/consolidated-analytics/tenants/{tenantId}/source-tenants:
get:
tags:
- ConsolidatedAnalytics
summary: Retrieve a consolidated analytics tenant's source tenants
description: "Retrieve a CA tenant's source tenants.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: ConsolidatedAnalytics_ListSourceTenants
parameters:
- name: tenantId
in: path
description: "The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY}\n is the consolidated analytic tenant code."
required: true
schema:
type: string
- name: limit
in: query
description: The maximum number of source tenants to return. The maximum value is 1000. Default is 400.
schema:
type: integer
format: int32
- name: start
in: query
description: The starting index of the first source tenant to return. Default is 0.
schema:
type: integer
format: int32
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPISourceTenantListDTO'
put:
tags:
- ConsolidatedAnalytics
summary: Set a consolidated analytics tenant's source tenants
description: "Define the source tenants for a consolidated analytics tenant.\n\n After you create a CA tenant, you must define a list of its source tenants. The source tenants are the tenants whose data is aggregated in the CA tenant.\n You can also use this API to replace the list of source tenants for an existing CA tenant.\n\n If successful, the response returns an updated list of source tenants.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: ConsolidatedAnalytics_SetSourceTenants
parameters:
- name: tenantId
in: path
description: "The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY}\n is the consolidated analytic tenant code."
required: true
schema:
type: string
- name: limit
in: query
description: The maximum number of source tenants to return. The maximum value is 1000. Default is 400.
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/admin.TenantCodeBody'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPISourceTenantListDTO'
delete:
tags:
- ConsolidatedAnalytics
summary: Remove source tenants from a consolidated analytics tenants
description: "Remove source tenants from the list of source tenants for a consolidated analytics tenant.\n\n If successful, the response returns an updated list of source tenants.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: ConsolidatedAnalytics_RemoveSourceTenants
parameters:
- name: tenantId
in: path
description: "The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY}\n is the consolidated analytic tenant code."
required: true
schema:
type: string
- name: limit
in: query
description: The maximum number of source tenants to return. The maximum value is 1000. Default is 400.
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/admin.TenantCodeBody'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPISourceTenantListDTO'
patch:
tags:
- ConsolidatedAnalytics
summary: Add source tenants to a consolidated analytics tenant
description: "Add source tenants to the list of source tenants for a consolidated analytics tenant.\n\n If successful, the response returns an updated list of source tenants.\n\n <br>**Note:** <em>This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.\n If you are interested in using this API, please contact your Customer Success Manager (CSM).</em>"
operationId: ConsolidatedAnalytics_AddSourceTenants
parameters:
- name: tenantId
in: path
description: "The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY}\n is the consolidated analytic tenant code."
required: true
schema:
type: string
- name: limit
in: query
description: The maximum number of source tenants to return. The maximum value is 1000. Default is 400.
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/admin.TenantCodeBody'
required: true
responses:
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPISourceTenantListDTO'
components:
schemas:
admin.TenantCodeBody:
type: object
properties:
tenantCodes:
type: array
items:
type: string
description: A list of a CA tenant's source tenants codes. The maximum length is 1000.
admin.ConsolidatedAnalyticsAPITenantCreateRequestDTO:
type: object
properties:
tenantCode:
type: string
description: "The ID of the tenant. For example, WFF_{XXX}~CA{YYY} where {XXX} is the administrating tenant code and {YYY}\n is the consolidated analytic tenant code."
admin.ConsolidatedAnalyticsAPISourceTenantListDTO:
type: object
properties:
tenantCodes:
type: array
items:
type: string
description: A list of the CA tenant's source tenants.
admin.ExcludedSourcesBody:
type: object
properties:
excludedSources:
type: array
items:
type: string
description: A list of a CA tenant's excluded sources.
admin.ConsolidatedAnalyticsAPITenantWithDetailsListResponseDTO:
type: object
properties:
tenants:
type: array
items:
$ref: '#/components/schemas/admin.ConsolidatedAnalyticsAPITenantWithDetails'
description: A list of CA tenants and their details.
admin.ConsolidatedAnalyticsAPIExcludedSourceListDTO:
type: object
properties:
excludedSources:
type: array
items:
type: string
description: A list of the CA tenant's excluded sources.
admin.ConsolidatedAnalyticsAPITenantListResponseDTO:
type: object
properties:
tenantCodes:
type: array
items:
type: string
description: A list of CA tenant codes.
admin.ConsolidatedAnalyticsAPITenantWithDetails:
type: object
properties:
tenantCode:
type: string
description: The CA tenant's code.
sourceTenantsList:
type: array
items:
type: string
description: A list of the CA tenant's source tenants.
excludedSourcesList:
type: array
items:
type: string
description: A list of the CA tenant's excluded sources.
Status:
type: object
properties:
localizedMessage:
type: string
description: Localized error message describing the root cause of the error.
code:
type: string
description: Error classification.
message:
type: string
description: Not used.
rci:
type: string
description: Optional root cause identifier.
userError:
type: boolean
description: Indicates whether the error is a user error.
description: The response structure for errors.
securitySchemes:
CookieAuth:
type: apiKey
name: VisierASIDToken
in: cookie
ApiKeyAuth:
type: apiKey
name: apikey
in: header
BearerAuth:
type: http
scheme: bearer
OAuth2Auth:
type: oauth2
flows:
authorizationCode:
authorizationUrl: /v1/auth/oauth2/authorize
tokenUrl: /v1/auth/oauth2/token
scopes:
read: Grants read access
write: Grants write access
password:
tokenUrl: /v1/auth/oauth2/token
scopes:
read: Grants read access
write: Grants write access
x-tagGroups:
- name: administration
tags:
- Projects
- ProductionVersions
- UsersV3
- UsersV2
- UserGroupsV2
- UsersV1
- Profiles
- Permissions
- TenantsV2
- TenantsV1
- ConsolidatedAnalytics
- Sources
- SystemStatus
- EmailDomains
- EncryptionKeys
- NetworkSubnets
- SidecarSolutions
- ReleaseVersionConfiguration
- VeeConfiguration