Clients Status Update Rbac Endpoints

Update Client Status

PUT /v1/endpoints/{uuid}/rbac/clients/{client_uuid}/status

Quick disable/reactivate switch. disabled or revoked clients can't authenticate (login attempts get 401), but their credentials, sessions table, role assignments, and audit history are all preserved — making this the right action when you might want to reactivate later. For permanent removal use DELETE.

Active sessions are not automatically revoked when a client is disabled — they continue until expiry. Pair with POST .../sessions/revoke-all to kick the user off everywhere immediately.

Path parameters

uuid string (uuid) Req

The endpoint's uuid from /endpoints.

client_uuid string (uuid) Req

The RBAC client's uuid. Resolved under this endpoint only.

Deprecated: the legacy integer id is still accepted in the path until the sunset, answered with Deprecation and Sunset headers. Use the uuid.

Request body

status string Req

One of invited | active | disabled | revoked.

Response (200 OK)

client_uuid string (uuid)

The updated client's uuid.

status string

The new status.

message string

"Client status updated successfully".

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

400 Bad Request

Invalid request body, or status not one of the four allowed values. An integer client id after the sunset (integer_id_unsupported).

401 Unauthorized

Missing auth.

403 Forbidden

Caller lacks the endpoints:update permission in the active account.

404 Not Found

Endpoint doesn't belong to the calling account, or the client isn't a client of this endpoint (client not found).

Request — disable
curl -X PUT "https://api.ngris.com/v1/endpoints/019bb1e4-e785-77d2-9966-c3cff31d0a0e/rbac/clients/019b4b9d-d300-736b-8601-153b3d9f70ee/status" \
  -H "X-API-KEY: <your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{"status": "disabled"}'

Python — disable + revoke all sessions
from ngris import Ngris

client = Ngris(api_key="<your_api_key>")
client._put_raw(
    "/endpoints/019bb1e4-e785-77d2-9966-c3cff31d0a0e/rbac/clients/019b4b9d-d300-736b-8601-153b3d9f70ee/status",
    {"status": "disabled"},
)
# Kick the user off any active sessions:
client._post_raw(
    "/endpoints/019bb1e4-e785-77d2-9966-c3cff31d0a0e/rbac/clients/019b4b9d-d300-736b-8601-153b3d9f70ee/sessions/revoke-all",
    {},
)

Response — 200 OK
{
  "client_uuid": "019b4b9d-d300-736b-8601-153b3d9f70ee",
  "status": "disabled",
  "message": "Client status updated successfully"
}

Was this helpful?

PreviousDelete Client NextList Client Sessions

On this page

Update Client Status

Was this helpful?