Skip to content
Authrim

Overview

OIDC UserInfo and protected customer profile APIs.

Authrim UserInfo API 0.5.0

Section titled “Authrim UserInfo API 0.5.0”

Initial OpenAPI contract for @authrim/ar-userinfo. 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 ”
GET
/api/health
GET
/health/live
GET
/health/ready
GET
/userinfo
POST
/userinfo
GET
/api/protected/customer-profiles/{userId}
PATCH
/api/protected/customer-profiles/users/{userId}
GET
/api/protected/fapi-resource

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth ”

Security scheme type: http

dpopAuth

Section titled “dpopAuth ”

DPoP-bound OAuth 2.0 access token accompanied by a DPoP proof header.

Security scheme type: http