Skip to content
Authrim

Overview

Dynamic client registration, token introspection, revocation, and self-service devices.

Authrim OAuth Management API 0.5.0

Section titled “Authrim OAuth Management API 0.5.0”

Initial OpenAPI contract for OAuth-adjacent management endpoints owned by @authrim/ar-management. Admin UI routes remain in admin.openapi.yaml. When coordinated SAML DR export is enabled, every operation can additionally return HTTP 503 while source updates are paused or update admission is unavailable. This availability response has Content-Type text/plain;charset=UTF-8, Cache-Control no-store, Retry-After 5, and the body “Service temporarily unavailable” (no response body for HEAD). Clients may retry after the indicated delay; a failed response does not establish whether an earlier write completed.

Information

  • OpenAPI version: 3.2.0

Operations

Section titled “ Operations ”
POST
/register
POST
/oauth/admin-agent/register
GET
/clients/{client_id}
PUT
/clients/{client_id}
DELETE
/clients/{client_id}
GET
/clients/{client_id}/config
POST
/introspect
POST
/revoke
POST
/revoke/batch
GET
/me/devices
DELETE
/me/devices/{id}
PATCH
/me/devices/{id}

Authentication

Section titled “ Authentication ”

initialAccessToken

Section titled “initialAccessToken ”

Initial access token for dynamic client registration.

Security scheme type: http

registrationAccessToken

Section titled “registrationAccessToken ”

Registration access token for client configuration endpoint operations.

Security scheme type: http

clientAuth

Section titled “clientAuth ”

OAuth client authentication represented as bearer where applicable.

Security scheme type: http

sessionCookie

Section titled “sessionCookie ”

Security scheme type: apiKey

Cookie parameter name: authrim_session