Organization
Users and User Groups
    API tokens
    Users - Entity APIs
      Get User entitiesgetPost User entitiespostGet User entitygetPut User entityputDelete User entitydeletePatch User entitypatch
    Users - Declarative APIs
    UserGroups - Entity APIs
    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

Users - Entity APIs (3.51)

Endpoint:/

Get User entities

GET
/api/v1/entities/users

User - represents entity interacting with platform

Get User 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
    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 User entities › Responses

Request successfully processed

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

    Included resources

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

Post User entities

POST
/api/v1/entities/users

User - represents entity interacting with platform

Post User 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
    ALL

Post User entities › Request Body

  • dataobject · required

    JSON:API representation of user entity.

Post User entities › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of user entity.

  • includedobject[] · unique

    Included resources

  • linksobject
POST /api/v1/entities/users

Get User entity

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

User - represents entity interacting with platform

Get User entity › path Parameters

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

Get User 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
    ALL

Get User entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of user entity.

  • includedobject[] · unique

    Included resources

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

Put User entity

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

User - represents entity interacting with platform

Put User entity › path Parameters

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

Put User 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
    ALL

Put User entity › Request Body

  • dataobject · required

    JSON:API representation of user entity.

Put User entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of user entity.

  • includedobject[] · unique

    Included resources

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

Delete User entity

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

User - represents entity interacting with platform

Delete User entity › path Parameters

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

Delete User 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 User entity › Responses

Successfully deleted

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

Patch User entity

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

User - represents entity interacting with platform

Patch User entity › path Parameters

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

Patch User 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
    ALL

Patch User entity › Request Body

  • dataobject · required

    JSON:API representation of patching user entity.

Patch User entity › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of user entity.

  • includedobject[] · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/users/{id}
API tokensUsers - Declarative APIs