Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Permission

Retrieve a single permission by its ID

Returns the permission record identified by {id}. Use this when you already have a specific permission id (obtained from POST /permissions or GET /permissions) and need its full details; for browsing the full catalog, use GET /permissions instead.

Preconditions: the caller must be authenticated and hold the READ_PERMISSION permission for the tenant.

On success, returns the matching permission (id, resource, action, description); createdAt and updatedAt are always null in the current implementation. Returns 404 when no permission with that id exists for the tenant.

get/permissions/{id}

Path parameters

idstring required

Server-assigned identifier of the permission to retrieve. Treat as an opaque string; pass back exactly the id value returned by GET /permissions or POST /permissions.

Headers

tenant-idstring required

Tenant identifier that scopes the lookup to a specific tenant's permission catalog.

Response

The permission matching the given id, including its resource, action, and description. Note: createdAt and updatedAt are always null in the current implementation.

idstring

Server-assigned unique identifier for the permission.

resourcestring

Name of the resource this permission governs (e.g. 'user', 'roster'). Mirrors the resource value supplied when the permission was created or last replaced.

actionstring

Name of the action this permission grants on the resource (e.g. 'read', 'create'). Mirrors the action value supplied when the permission was created or last replaced.

descriptionstring

Human-readable explanation of what the permission allows. Optional; may be null if it was not supplied at creation.

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "perm-123-456-789",
  "resource": "user",
  "action": "read",
  "description": "Allows reading user profiles",
  "createdAt": "2022-03-10T12:15:50-04:00",
  "updatedAt": "2022-03-10T12:15:50-04:00"
}