Check user permissions

Checks one or more resource/action pairs for the requested user (or current API-key user).

RBAC · permission

Request body

Content type: application/json · schema AccessPermissionChecksBodyV1

user_idstring <uuid>

permissionsarray of objectRequired

min items 1

itemsobject

resourcestringRequired

actionstringRequired

Response body

Success response 200 · schema AccessApiSuccessV1

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Operation succeeded.

400

Validation failed (payload/query/path parsing).

401

API key missing/invalid or key user not found.

403

RBAC denied for permission:read.

500

Unexpected controller/service failure.

POST /api/v1/permission-checks

cURL

curl -X POST "https://algapsa.com/api/v1/permission-checks" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "user_id": "01HN2K7VRB9PQ3Y0000000000",
  "permissions": [
    {
      "resource": "string",
      "action": "string"
    }
  ]
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/permission-checks", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "user_id": "01HN2K7VRB9PQ3Y0000000000",
    "permissions": [
      {
        "resource": "string",
        "action": "string"
      }
    ]
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/permission-checks");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""user_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""permissions"": [
    {
      ""resource"": ""string"",
      ""action"": ""string""
    }
  ]
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}