Information
- OpenAPI version:
3.2.0
Overview
Authenticated user consent and data export endpoints.
Authrim User Self-Service API 0.5.0
Section titled “Authrim User Self-Service API 0.5.0”OpenAPI contract for user-facing self-service endpoints owned by the management Worker. 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.
Authentication
Section titled “ Authentication ”userBearer
Section titled “userBearer ”End-user access token. Data export requires a data_export or authrim:data_export scope when bearer authentication is used.
Security scheme type: http
userSessionCookie
Section titled “userSessionCookie ”End-user browser session cookie (the login session of the tenant). The legacy sid cookie is no longer read.
Security scheme type: apiKey
Cookie parameter name: authrim_session
accountSessionCookie
Section titled “accountSessionCookie ”LoginUI Account Page browser session cookie.
Security scheme type: apiKey
Cookie parameter name: authrim_session