Domains API reference guide
The collections object represents a domain you've created that contains data sources and assigned permissions. Currently, the only collection type available is a domain, so collections and domains are referred to interchangeably throughout this page.
id string
The unique identifier of the domain.
name string
The name of the domain.
description string
The description of the domain that will be displayed for users.
createdBy integer
The unique identifier of the user who created the domain.
profile.name string
The name of the user who created the domain.
createdAt timestamp
The date and time the domain was created.
updatedAt timestamp
The date and time the domain was updated.
type string
The type of collection. Value is domain.
POST
Creates a new domain
GET
Retrieves all domains
GET
Retrieves a specific domain
GET
Retrieves a specific domain by name
PUT
Updates a domain name or description
DELETE
Deletes a domain
POST
Adds data sources to a domain
GET
Retrieves the data sources in the domain
DELETE
Deletes a data source from a domain
POST
Assigns a domain permission to a user
GET
Retrieves user permissions assigned in the domain
DELETE
Removes a domain permission from a user by the permission ID
DELETE
Removes a domain permission from a user by the user ID and permission type.
POST /collectionCreate a new domain. You must have the global GOVERNANCE permission to create a domain. You can add data sources to the domain after creating the domain.
id string
The unique identifier of the domain.
Required
-
-
name string
The name of the domain.
Required
-
-
description string
The description of the domain that will be displayed for users.
Optional
-