Get RBAC Overview
Aggregate snapshot of the entire RBAC state for an endpoint — the full clients, roles, and memberships arrays returned together. One call instead of three. Use it to render the RBAC tab in the dashboard.
For the individual lists, use /clients, /roles, /memberships respectively.
Path parameters
uuid string (uuid) Req
The endpoint's
uuid from /endpoints.Response (200 OK)
endpoint_uuid string (uuid)
The endpoint's
uuid.clients array<object>
Full list of RBAC clients (same object shape as /clients).
roles array<object>
Full list of roles (same object shape as /roles).
memberships array<object>
Full list of
(client_uuid, role_uuid) pairings (same object shape as /memberships).The three lists are always present; each is [] when empty.
Deprecated: until the sunset this response also carries the legacy integer id and *_id fields. Don't use them; read uuid and the *_uuid fields.
Errors
401 Unauthorized
Missing auth.
403 Forbidden
Caller lacks the
endpoints:read permission in the active account.404 Not Found
Endpoint doesn't exist or doesn't belong to the calling account.
Request
curl "https://api.ngris.com/v1/endpoints/019bb1e4-e785-77d2-9966-c3cff31d0a0e/rbac" \
-H "X-API-KEY: <your_api_key>"
Python
from ngris import Ngris
client = Ngris(api_key="<your_api_key>")
overview = client.endpoint_rbac.get_rbac("019bb1e4-e785-77d2-9966-c3cff31d0a0e")
print(f"{len(overview['clients'])} clients, "
f"{len(overview['roles'])} roles")
Response — 200 OK
{
"endpoint_uuid": "019bb1e4-e785-77d2-9966-c3cff31d0a0e",
"clients": [
{
"uuid": "019b4b9d-d300-736b-8601-153b3d9f70ee",
"identifier": "alice@example.com",
"display_name": "Alice",
"email": "alice@example.com",
"status": "active",
"has_password": true,
"has_token": false,
"has_oauth": false,
"registration_source": "admin",
"created_at": "2026-05-01T10:00:00Z",
"updated_at": "2026-05-01T10:00:00Z"
}
],
"roles": [
{
"uuid": "019b5fc1-0eb5-7dd8-a0e9-a575428f890d",
"name": "editor",
"priority": 10,
"is_default": false,
"created_at": "2026-05-01T10:00:00Z",
"updated_at": "2026-05-01T10:00:00Z"
}
],
"memberships": [
{
"client_uuid": "019b4b9d-d300-736b-8601-153b3d9f70ee",
"role_uuid": "019b5fc1-0eb5-7dd8-a0e9-a575428f890d",
"assigned_by_uuid": "019a52c2-ca1e-78ba-ab5c-50362cc29134",
"created_at": "2026-05-01T10:00:00Z",
"updated_at": "2026-05-01T10:00:00Z"
}
]
}
Was this helpful?