Organization
Users and User Groups
    API tokens
    Users - Entity APIs
    Users - Declarative APIs
    UserGroups - Entity APIs
    UserGroups - Declarative APIs
    User Authorization
    User Settings
    User Identifiers
    User management
      /api/v1/actions/userManagement/assignPermissionspost/api/v1/actions/userManagement/removeUsersUserGroupspost/api/v1/actions/userManagement/revokePermissionspost/api/v1/actions/userManagement/userGroupsget/api/v1/actions/userManagement/userGroups/{userGroupId}/addMemberspost/api/v1/actions/userManagement/userGroups/{userGroupId}/membersget/api/v1/actions/userManagement/userGroups/{userGroupId}/permissionsget/api/v1/actions/userManagement/userGroups/{userGroupId}/permissionspost/api/v1/actions/userManagement/userGroups/{userGroupId}/removeMemberspost/api/v1/actions/userManagement/usersget/api/v1/actions/userManagement/users/{userId}/permissionsget/api/v1/actions/userManagement/users/{userId}/permissionspost/api/v1/actions/workspaces/{workspaceId}/userGroupsget/api/v1/actions/workspaces/{workspaceId}/usersget
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
AI Lake
AI Assistant
Agents
Other
Schemas
powered by Zudoku
OpenAPI definition

User management

Endpoint:/

Use case APIs for user management

POST
/api/v1/actions/userManagement/assignPermissions

Request Body

  • assigneesobject[] · required
  • dataSourcesobject[]
  • workspacesobject[]

Responses

OK

No data returned
POST /api/v1/actions/userManagement/assignPermissions

POST
/api/v1/actions/userManagement/removeUsersUserGroups

Request Body

  • idstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

    Identifier of the assignee.

  • typestring · enum · required
    Enum values:
    user
    userGroup

Responses

OK

No data returned
POST /api/v1/actions/userManagement/removeUsersUserGroups

POST
/api/v1/actions/userManagement/revokePermissions

Request Body

  • assigneesobject[] · required
  • dataSourcesobject[]
  • workspacesobject[]

Responses

OK

No data returned
POST /api/v1/actions/userManagement/revokePermissions

GET
/api/v1/actions/userManagement/userGroups

query Parameters

  • pageinteger · int32 · style: form

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger · int32 · style: form

    The size of the page to be returned.

    Default: 20
  • namestring · style: form

    Filter by user name. Note that user name is case insensitive.

  • workspacestring · style: form

    Filter by workspaceId.

  • dataSourcestring · style: form

    Filter by dataSourceId.

Responses

OK

  • totalCountinteger · int32 · required

    Total number of groups

  • userGroupsobject[] · required
GET /api/v1/actions/userManagement/userGroups

POST
/api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers

path Parameters

  • userGroupIdstring · required

Request Body

  • membersobject[] · required

Responses

No Content

No data returned
POST /api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers

GET
/api/v1/actions/userManagement/userGroups/{userGroupId}/members

path Parameters

  • userGroupIdstring · required

Responses

OK

  • membersobject[] · required
GET /api/v1/actions/userManagement/userGroups/{userGroupId}/members

GET
/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions

path Parameters

  • userGroupIdstring · required

query Parameters

  • includeInheritedboolean · style: form

    When true, include permissions inherited from parent user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the group gains access. Defaults to false (direct assignments only).

    Default: false

Responses

OK

  • dataSourcesobject[] · required
  • workspacesobject[] · required
GET /api/v1/actions/userManagement/userGroups/{userGroupId}/permissions

POST
/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions

path Parameters

  • userGroupIdstring · required

Request Body

  • dataSourcesobject[] · required
  • workspacesobject[] · required

Responses

No Content

No data returned
POST /api/v1/actions/userManagement/userGroups/{userGroupId}/permissions

POST
/api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers

path Parameters

  • userGroupIdstring · required

Request Body

  • membersobject[] · required

Responses

No Content

No data returned
POST /api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers

GET
/api/v1/actions/userManagement/users

query Parameters

  • pageinteger · int32 · style: form

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger · int32 · style: form

    The size of the page to be returned.

    Default: 20
  • namestring · style: form

    Filter by user name. Note that user name is case insensitive.

  • workspacestring · style: form

    Filter by workspaceId.

  • groupstring · style: form

    Filter by userGroupId.

  • dataSourcestring · style: form

    Filter by dataSourceId.

Responses

OK

  • totalCountinteger · int32 · required

    The total number of users is based on applied filters.

  • usersobject[] · required
GET /api/v1/actions/userManagement/users

GET
/api/v1/actions/userManagement/users/{userId}/permissions

path Parameters

  • userIdstring · required

query Parameters

  • includeInheritedboolean · style: form

    When true, include permissions inherited from user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the user gains access. Defaults to false (direct assignments only).

    Default: false

Responses

OK

  • dataSourcesobject[] · required
  • workspacesobject[] · required
GET /api/v1/actions/userManagement/users/{userId}/permissions

POST
/api/v1/actions/userManagement/users/{userId}/permissions

path Parameters

  • userIdstring · required

Request Body

  • dataSourcesobject[] · required
  • workspacesobject[] · required

Responses

No Content

No data returned
POST /api/v1/actions/userManagement/users/{userId}/permissions

GET
/api/v1/actions/workspaces/{workspaceId}/userGroups

path Parameters

  • workspaceIdstring · required

query Parameters

  • pageinteger · int32 · style: form

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger · int32 · style: form

    The size of the page to be returned.

    Default: 20
  • namestring · style: form

    Filter by user name. Note that user name is case insensitive.

Responses

OK

  • totalCountinteger · int32 · required

    Total number of groups

  • userGroupsobject[] · required
GET /api/v1/actions/workspaces/{workspaceId}/userGroups

GET
/api/v1/actions/workspaces/{workspaceId}/users

path Parameters

  • workspaceIdstring · required

query Parameters

  • pageinteger · int32 · style: form

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger · int32 · style: form

    The size of the page to be returned.

    Default: 20
  • namestring · style: form

    Filter by user name. Note that user name is case insensitive.

Responses

OK

  • totalCountinteger · int32 · required

    The total number of users is based on applied filters.

  • usersobject[] · required
GET /api/v1/actions/workspaces/{workspaceId}/users
User IdentifiersPermissions