Management clients

These routes require an admin-console access token and an assigned admin login relationship. Base route: /api/v1/management/clients.

MethodRoutePurpose
GET/api/v1/management/clientsList clients with pagination and filters.
GET/api/v1/management/clients/{id_or_client_id}Read one client by UUID or public client ID.
POST/api/v1/management/clientsCreate a client.
PUT/api/v1/management/clients/{id}Update a client.
DELETE/api/v1/management/clients/{id}Delete a client.
POST/api/v1/management/clients/rotate-secretRotate a confidential-client secret using the body-supplied client reference.

Relationships and grants

Nested routes manage client resources, roles, users, and directory-sources with GET, POST, and DELETE under /api/v1/management/clients/{id}.

OAuth protected-resource grants use:

  • GET /api/v1/management/clients/{client_id}/oauth-grants
  • PUT /api/v1/management/clients/{client_id}/oauth-grants/{resource_key}
  • DELETE /api/v1/management/clients/{client_id}/oauth-grants/{resource_key}

Changing a live OAuth grant updates the authorization version used to reject stale tokens.

Was this page helpful?