Organization
Users and User Groups
    API tokens
    Users - Entity APIs
    Users - Declarative APIs
    UserGroups - Entity APIs
      Get UserGroup entitiesgetPost User Group entitiespostGet UserGroup entitygetPut UserGroup entityputDelete UserGroup entitydeletePatch UserGroup entitypatch
    UserGroups - Declarative APIs
    User Authorization
    User Settings
    User Identifiers
    User management
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

UserGroups - Entity APIs (3.51)

Endpoint:/

Get UserGroup entities

GET
/api/v1/entities/userGroups

User Group - creates tree-like structure for categorizing users

Get UserGroup entities › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userGroups
    parents
    ALL
  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    page
    all
    ALL

Get UserGroup entities › Responses

Request successfully processed

  • dataobject[] · unique · required
  • includedobject[] · unique

    Included resources

  • linksobject
  • metaobject
GET /api/v1/entities/userGroups

Post User Group entities

POST
/api/v1/entities/userGroups

User Group - creates tree-like structure for categorizing users

Post User Group entities › query Parameters

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userGroups
    parents
    ALL

Post User Group entities › Request Body

  • dataobject · required

    JSON:API representation of userGroup entity.

Post User Group entities › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of userGroup entity.

  • includedobject[] · unique

    Included resources

  • linksobject
POST /api/v1/entities/userGroups

Get UserGroup entity

GET
/api/v1/entities/userGroups/{id}

User Group - creates tree-like structure for categorizing users

Get UserGroup entity › path Parameters

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

Get UserGroup entity › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userGroups
    parents
    ALL

Get UserGroup entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of userGroup entity.

  • includedobject[] · unique

    Included resources

  • linksobject
GET /api/v1/entities/userGroups/{id}

Put UserGroup entity

PUT
/api/v1/entities/userGroups/{id}

User Group - creates tree-like structure for categorizing users

Put UserGroup entity › path Parameters

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

Put UserGroup entity › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userGroups
    parents
    ALL

Put UserGroup entity › Request Body

  • dataobject · required

    JSON:API representation of userGroup entity.

Put UserGroup entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of userGroup entity.

  • includedobject[] · unique

    Included resources

  • linksobject
PUT /api/v1/entities/userGroups/{id}

Delete UserGroup entity

DELETE
/api/v1/entities/userGroups/{id}

User Group - creates tree-like structure for categorizing users

Delete UserGroup entity › path Parameters

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

Delete UserGroup entity › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Delete UserGroup entity › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/userGroups/{id}

Patch UserGroup entity

PATCH
/api/v1/entities/userGroups/{id}

User Group - creates tree-like structure for categorizing users

Patch UserGroup entity › path Parameters

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

Patch UserGroup entity › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userGroups
    parents
    ALL

Patch UserGroup entity › Request Body

  • dataobject · required

    JSON:API representation of patching userGroup entity.

Patch UserGroup entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of userGroup entity.

  • includedobject[] · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/userGroups/{id}
Users - Declarative APIsUserGroups - Declarative APIs