GetPermissions

[POST] .../v1/user/getpermissions

Returns a user permission matrix. Inspect effective permission values for one or more users before building administration screens or diagnosing access behavior. The response returns user_id, permission_id and boolean value rows; the request body is required and supports filters for id, user_id, permission_id and last_update. this method does not perform a dedicated permission check, but it still runs in the current request user context and the method may return lookup or storage errors. Missing body, invalid filters, unsupported filter fields and failures are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
id int User permission assignment IDs.
last_update int Lower boundary for permission assignment last update time as Unix time.
permission_id int Permission IDs.
user_id int User IDs.

Request Example

{
  "filters": [
    {
      "Field": "user_id",
      "Operator": "In",
      "Value": "17,18"
    },
    {
      "Field": "permission_id",
      "Operator": "In",
      "Value": "1,2"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of UserPermissionShort Result array.

Response Example

{
  "ok": true,
  "result": [
    {
      "user_id": 17,
      "permission_id": 1,
      "value": true
    }
  ]
}