Organization
Users and User Groups
Permissions
    Permissions
      Manage Permissions for a Data SourcepostManage Permissions for a OrganizationpostGet Available AssigneesgetManage Permissions for a DashboardpostGet Dashboard PermissionsgetManage Permissions for an AttributepostGet Attribute Permissionsget(BETA) Manage Permissions for a Computed Attributepost(BETA) Get Computed Attribute PermissionsgetManage Permissions for a FactpostGet Fact PermissionsgetManage Permissions for a LabelpostGet Label PermissionsgetManage Permissions for a Workspacepost(BETA) Manage Permissions for a Metricpost(BETA) Get Metric Permissionsget(BETA) Manage Permissions for a Visualizationpost(BETA) Get Visualization PermissionsgetGet organization permissionsgetSet organization permissionsputGet permissions for the user-groupgetSet permissions for the user-groupputGet permissions for the usergetSet permissions for the userputGet permissions for the workspacegetSet permissions for the workspaceput
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reports
Reporting
Export & Automations
AI Lake
AI Assistant
Agents
Other
Schemas
powered by Zudoku
OpenAPI definition

Permissions

Endpoint:/

Manage Permissions for a Data Source

POST
/api/v1/actions/dataSources/{dataSourceId}/managePermissions

Manage Permissions for a Data Source

Manage Permissions for a Data Source › path Parameters

  • dataSourceIdstring · required

Manage Permissions for a Data Source › Request Body

  • assigneeIdentifierobject · required

    Identifier of a user or user-group.

  • permissionsstring[] · required
    Enum values:
    MANAGE
    USE

Manage Permissions for a Data Source › Responses

No Content

No data returned
POST /api/v1/actions/dataSources/{dataSourceId}/managePermissions

Manage Permissions for a Organization

POST
/api/v1/actions/organization/managePermissions

Manage Permissions for a Organization

Manage Permissions for a Organization › Request Body

  • assigneeIdentifierobject · required

    Identifier of a user or user-group.

  • permissionsstring[] · required
    Enum values:
    MANAGE
    SELF_CREATE_TOKEN
    BASE_UI_ACCESS

Manage Permissions for a Organization › Responses

No Content

No data returned
POST /api/v1/actions/organization/managePermissions

Get Available Assignees

GET
/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees

Get Available Assignees › path Parameters

  • workspaceIdstring · required
  • dashboardIdstring · required

Get Available Assignees › Responses

OK

  • userGroupsobject[] · required

    List of user groups

  • usersobject[] · required

    List of users

GET /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees

Manage Permissions for a Dashboard

POST
/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions

Manage Permissions for a Dashboard › path Parameters

  • workspaceIdstring · required
  • dashboardIdstring · required

Manage Permissions for a Dashboard › Request Body

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: assigneeIdentifier, permissions
type = object · requires: assigneeRule, permissions
Properties for Variant 1:

Desired levels of permissions for an assignee identified by an identifier.

  • permissionsstring[] · required
    Enum values:
    EDIT
    SHARE
    VIEW
  • assigneeIdentifierobject · required

    Identifier of a user or user-group.

Manage Permissions for a Dashboard › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions

Get Dashboard Permissions

GET
/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions

Get Dashboard Permissions › path Parameters

  • workspaceIdstring · required
  • dashboardIdstring · required

Get Dashboard Permissions › Responses

OK

  • rulesobject[] · required

    List of rules

  • userGroupsobject[] · required

    List of user groups

  • usersobject[] · required

    List of users

GET /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions

Manage Permissions for an Attribute

POST
/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions

Manage Permissions for an Attribute › path Parameters

  • workspaceIdstring · required
  • attributeIdstring · required

Manage Permissions for an Attribute › Request Body

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: assigneeIdentifier, permissions
type = object · requires: assigneeRule, permissions
Properties for Variant 1:

Desired levels of attribute permissions for an assignee identified by an identifier.

  • permissionsstring[] · required
    Enum values:
    EDIT
    SHARE
    VIEW
  • assigneeIdentifierobject · required

    Identifier of a user or user-group.

Manage Permissions for an Attribute › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions

Get Attribute Permissions

GET
/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions

Get Attribute Permissions › path Parameters

  • workspaceIdstring · required
  • attributeIdstring · required

Get Attribute Permissions › Responses

OK

  • rulesobject[] · required

    List of rules

  • userGroupsobject[] · required

    List of user groups

  • usersobject[] · required

    List of users

GET /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions

(BETA) Manage Permissions for a Computed Attribute

POST
/api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions

(BETA) Manage Permissions for a Computed Attribute › path Parameters

  • workspaceIdstring · required
  • computedAttributeIdstring · required

(BETA) Manage Permissions for a Computed Attribute › Request Body

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: assigneeIdentifier, permissions
type = object · requires: assigneeRule, permissions
Properties for Variant 1:

Desired levels of computed-attribute permissions for an assignee identified by an identifier.

  • permissionsstring[] · required
    Enum values:
    EDIT
    SHARE
    VIEW
  • assigneeIdentifierobject · required

    Identifier of a user or user-group.

(BETA) Manage Permissions for a Computed Attribute › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions

(BETA) Get Computed Attribute Permissions

GET
/api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions

(BETA) Get Computed Attribute Permissions › path Parameters

  • workspaceIdstring · required
  • computedAttributeIdstring · required

(BETA) Get Computed Attribute Permissions › Responses

OK

  • rulesobject[] · required

    List of rules

  • userGroupsobject[] · required

    List of user groups

  • usersobject[] · required

    List of users

GET /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions

Manage Permissions for a Fact

POST
/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions

Manage Permissions for a Fact › path Parameters

  • workspaceIdstring · required
  • factIdstring · required

Manage Permissions for a Fact › Request Body

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: assigneeIdentifier, permissions
type = object · requires: assigneeRule, permissions
Properties for Variant 1:

Desired levels of fact permissions for an assignee identified by an identifier.

  • permissionsstring[] · required
    Enum values:
    EDIT
    SHARE
    VIEW
  • assigneeIdentifierobject · required

    Identifier of a user or user-group.

Manage Permissions for a Fact › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions

Get Fact Permissions

GET
/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions

Get Fact Permissions › path Parameters

  • workspaceIdstring · required
  • factIdstring · required

Get Fact Permissions › Responses

OK

  • rulesobject[] · required

    List of rules

  • userGroupsobject[] · required

    List of user groups

  • usersobject[] · required

    List of users

GET /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions

Manage Permissions for a Label

POST
/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions

Manage Permissions for a Label › path Parameters

  • workspaceIdstring · required
  • labelIdstring · required

Manage Permissions for a Label › Request Body

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: assigneeIdentifier, permissions
type = object · requires: assigneeRule, permissions
Properties for Variant 1:

Desired levels of label permissions for an assignee identified by an identifier.

  • permissionsstring[] · required
    Enum values:
    EDIT
    SHARE
    VIEW
  • assigneeIdentifierobject · required

    Identifier of a user or user-group.

Manage Permissions for a Label › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions

Get Label Permissions

GET
/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions

Get Label Permissions › path Parameters

  • workspaceIdstring · required
  • labelIdstring · required

Get Label Permissions › Responses

OK

  • rulesobject[] · required

    List of rules

  • userGroupsobject[] · required

    List of user groups

  • usersobject[] · required

    List of users

GET /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions

Manage Permissions for a Workspace

POST
/api/v1/actions/workspaces/{workspaceId}/managePermissions

Manage Permissions for a Workspace and its Workspace Hierarchy

Manage Permissions for a Workspace › path Parameters

  • workspaceIdstring · required

Manage Permissions for a Workspace › Request Body

  • assigneeIdentifierobject · required

    Identifier of a user or user-group.

  • hierarchyPermissionsstring[]
    Enum values:
    MANAGE
    ANALYZE
    EXPORT
    EXPORT_TABULAR
    EXPORT_PDF
    CREATE_AUTOMATION
    USE_AI_ASSISTANT
    WRITE_KNOWLEDGE_DOCUMENTS
  • permissionsstring[]
    Enum values:
    MANAGE
    ANALYZE
    EXPORT
    EXPORT_TABULAR
    EXPORT_PDF
    CREATE_AUTOMATION
    USE_AI_ASSISTANT
    WRITE_KNOWLEDGE_DOCUMENTS

Manage Permissions for a Workspace › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/managePermissions

(BETA) Manage Permissions for a Metric

POST
/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions

(BETA) Manage Permissions for a Metric › path Parameters

  • workspaceIdstring · required
  • metricIdstring · required

(BETA) Manage Permissions for a Metric › Request Body

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: assigneeIdentifier, permissions
type = object · requires: assigneeRule, permissions
Properties for Variant 1:

Desired levels of metric permissions for an assignee identified by an identifier.

  • permissionsstring[] · required
    Enum values:
    EDIT
    SHARE
    VIEW
  • assigneeIdentifierobject · required

    Identifier of a user or user-group.

(BETA) Manage Permissions for a Metric › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions

(BETA) Get Metric Permissions

GET
/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions

(BETA) Get Metric Permissions › path Parameters

  • workspaceIdstring · required
  • metricIdstring · required

(BETA) Get Metric Permissions › Responses

OK

  • rulesobject[] · required

    List of rules

  • userGroupsobject[] · required

    List of user groups

  • usersobject[] · required

    List of users

GET /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions

(BETA) Manage Permissions for a Visualization

POST
/api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions

(BETA) Manage Permissions for a Visualization › path Parameters

  • workspaceIdstring · required
  • visualizationObjectIdstring · required

(BETA) Manage Permissions for a Visualization › Request Body

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · requires: assigneeIdentifier, permissions
type = object · requires: assigneeRule, permissions
Properties for Variant 1:

Desired levels of visualization permissions for an assignee identified by an identifier.

  • permissionsstring[] · required
    Enum values:
    EDIT
    SHARE
    VIEW
  • assigneeIdentifierobject · required

    Identifier of a user or user-group.

(BETA) Manage Permissions for a Visualization › Responses

No Content

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions

(BETA) Get Visualization Permissions

GET
/api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions

(BETA) Get Visualization Permissions › path Parameters

  • workspaceIdstring · required
  • visualizationObjectIdstring · required

(BETA) Get Visualization Permissions › Responses

OK

  • rulesobject[] · required

    List of rules

  • userGroupsobject[] · required

    List of user groups

  • usersobject[] · required

    List of users

GET /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions

Get organization permissions

GET
/api/v1/layout/organization/permissions

Retrieve organization permissions

Get organization permissions › Responses

Retrieved all organization permissions.

  • assigneeobject · required

    Identifier of a user or user-group.

  • namestring · enum · required

    Permission name.

    Enum values:
    MANAGE
    SELF_CREATE_TOKEN
    BASE_UI_ACCESS
GET /api/v1/layout/organization/permissions

Set organization permissions

PUT
/api/v1/layout/organization/permissions

Sets organization permissions

Set organization permissions › Request Body

  • assigneeobject · required

    Identifier of a user or user-group.

  • namestring · enum · required

    Permission name.

    Enum values:
    MANAGE
    SELF_CREATE_TOKEN
    BASE_UI_ACCESS

Set organization permissions › Responses

Organization permissions set.

No data returned
PUT /api/v1/layout/organization/permissions

Get permissions for the user-group

GET
/api/v1/layout/userGroups/{userGroupId}/permissions

Retrieve current set of permissions of the user-group in a declarative form.

Get permissions for the user-group › path Parameters

  • userGroupIdstring · required

Get permissions for the user-group › Responses

Retrieved current set of permissions.

  • permissionsobject[]
GET /api/v1/layout/userGroups/{userGroupId}/permissions

Set permissions for the user-group

PUT
/api/v1/layout/userGroups/{userGroupId}/permissions

Set effective permissions for the user-group

Set permissions for the user-group › path Parameters

  • userGroupIdstring · required

Set permissions for the user-group › Request Body

  • permissionsobject[]

Set permissions for the user-group › Responses

User-group permissions successfully set.

No data returned
PUT /api/v1/layout/userGroups/{userGroupId}/permissions

Get permissions for the user

GET
/api/v1/layout/users/{userId}/permissions

Retrieve current set of permissions of the user in a declarative form.

Get permissions for the user › path Parameters

  • userIdstring · required

Get permissions for the user › Responses

Retrieved current set of permissions.

  • permissionsobject[]
GET /api/v1/layout/users/{userId}/permissions

Set permissions for the user

PUT
/api/v1/layout/users/{userId}/permissions

Set effective permissions for the user

Set permissions for the user › path Parameters

  • userIdstring · required

Set permissions for the user › Request Body

  • permissionsobject[]

Set permissions for the user › Responses

User permissions successfully set.

No data returned
PUT /api/v1/layout/users/{userId}/permissions

Get permissions for the workspace

GET
/api/v1/layout/workspaces/{workspaceId}/permissions

Retrieve current set of permissions of the workspace in a declarative form.

Get permissions for the workspace › path Parameters

  • workspaceIdstring · required

Get permissions for the workspace › Responses

Retrieved current set of permissions.

  • hierarchyPermissionsobject[]
  • permissionsobject[]
GET /api/v1/layout/workspaces/{workspaceId}/permissions

Set permissions for the workspace

PUT
/api/v1/layout/workspaces/{workspaceId}/permissions

Set effective permissions for the workspace

Set permissions for the workspace › path Parameters

  • workspaceIdstring · required

Set permissions for the workspace › Request Body

  • hierarchyPermissionsobject[]
  • permissionsobject[]

Set permissions for the workspace › Responses

Workspace permissions successfully set.

No data returned
PUT /api/v1/layout/workspaces/{workspaceId}/permissions
User managementData Source - Declarative APIs