Users

Get all entities

/v1/users

Request parameters

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "data": [
    {},
    {}
  ]
}

Create entity

/v1/users

Request parameters

{}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "data": {}
}

Get all entities paginated

/v1/users/paginated

Request parameters

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "data": {
    "items": [
      {},
      {}
    ],
    "pageInfo": {
      "pageIndex": 83,
      "pageSize": 56,
      "totalElements": 71,
      "totalPages": 48
    }
  }
}

Get entity by identity

/v1/users/by_identity/{identity}

Request parameters

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "data": {}
}

Get entity by id

/v1/users/{id}

Request parameters

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "data": {}
}

Delete entity

/v1/users/{id}

Request parameters

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

Update entity

/v1/users/{id}

Request parameters

{}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

{
  "data": {}
}

Add roles to entity with id

/v1/users/{id}/roles/add

Request parameters

{
  "roleIds": [
    {},
    {}
  ],
  "organizationId": {}
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

Remove roles from entity with id

/v1/users/{id}/roles/remove

Request parameters

{
  "roleIds": [
    {},
    {}
  ],
  "organizationId": {}
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

Add permissions to entity with id

/v1/users/{id}/permissions/add

Request parameters

{
  "permissionIds": [
    {},
    {}
  ],
  "organizationId": {}
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

Remove permissions from entity with id

/v1/users/{id}/permissions/remove

Request parameters

{
  "permissionIds": [
    {},
    {}
  ],
  "organizationId": {}
}

Responses

{
  "errors": [
    {
      "i18N": "example",
      "error": "example",
      "type": "example"
    }
  ]
}

Last modified: 17 August 2024