Docs / Fulan Auth Service

Fulan Auth Service

Live OpenAPI from the auth service. Use this to explore endpoints and map operations to client workflows.

/.well-known/jwks.json
Expand
GET
JWKS endpoint
operationId: getJWKS
200503
/.well-known/openid-configuration
Expand
GET
OIDC discovery document
operationId: getOIDCDiscovery
200
/admin/correlation
Expand
GET
Admin correlation query (audited)
operationId: getAdminCorrelation
Parameters
subject_type (query) (required)
subject_id (query) (required)
200400401
/admin/scopes/grants
Expand
POST
Grant a global scope to a global user (admin-only)
operationId: postAdminGlobalScopeGrant
request body204400401
DELETE
Revoke a global scope from a global user (admin-only)
operationId: deleteAdminGlobalScopeGrant
request body204400401
/apps
Expand
GET
List apps created by the caller (admin lists all)
operationId: getApps
200401
POST
Create app registration
operationId: postApps
request body201401
/apps/{client_id}
Expand
GET
Get app registration
operationId: getApp
Parameters
client_id (path) (required)
200401404
PATCH
Update app registration
operationId: patchApp
Parameters
client_id (path) (required)
request body200401404
/apps/{client_id}/delete
Expand
POST
Soft delete app and revoke refresh sessions
operationId: postAppDelete
Parameters
client_id (path) (required)
204401404
/apps/{client_id}/disable
Expand
POST
Disable app
operationId: postAppDisable
Parameters
client_id (path) (required)
204400401404
/apps/{client_id}/enable
Expand
POST
Enable app
operationId: postAppEnable
Parameters
client_id (path) (required)
204400401404
/apps/{client_id}/recover
Expand
POST
Recover app from soft delete
operationId: postAppRecover
Parameters
client_id (path) (required)
204401404
/authorize
Expand
GET
OAuth2 authorization endpoint (Authorization Code + PKCE)
operationId: getAuthorize
Parameters
response_type (query) (required)
client_id (query) (required)
redirect_uri (query) (required)
scope (query) (required)
identifier_type (query)
identifier_value (query)
state (query)
code_challenge (query) (required)
code_challenge_method (query) (required)
302400
/correlation/self
Expand
GET
List apps correlated to the caller based on verified global identifiers (self-only)
operationId: getCorrelationSelf
200401403
/debug/vars
Expand
GET
expvar metrics
operationId: getDebugVars
200
/docs
Expand
GET
Swagger UI
operationId: getDocs
200
/healthz
Expand
GET
Liveness probe
operationId: getHealthz
200
/link/confirm
Expand
POST
Confirm linking (global identity side): requires auth:link:write, explicit consent, and re-auth OTP
operationId: postLinkConfirm
request body204400401409429
/link/initiate
Expand
POST
Initiate linking (app account side): requires auth:link:write and app linkingEnabled
operationId: postLinkInitiate
request body200400401403429
/logout
Expand
POST
Logout: revoke current refresh session
operationId: postLogout
request body204400401
/logout/all
Expand
POST
Logout all devices: revoke all refresh sessions for the subject in this app
operationId: postLogoutAll
204401
/openapi.json
Expand
GET
OpenAPI specification
operationId: getOpenAPI
200
/otp/send
Expand
POST
Send OTP (stub delivery) with rate limiting
operationId: postOTPSend
request body200400429
/otp/verify
Expand
POST
Verify OTP with rate limiting and attempt lockout
operationId: postOTPVerify
request body204400429
/password/forgot
Expand
POST
Forgot password (OTP): request reset code (only when OTP verification is enabled for the app)
operationId: postPasswordForgot
request body200400429
/password/reset
Expand
POST
Reset password (OTP): verify OTP and set a new password
operationId: postPasswordReset
request body204400429
/readyz
Expand
GET
Readiness probe (DB connectivity)
operationId: getReadyz
200503
/signup
Expand
POST
Create a developer (portal) account
operationId: postSignup
request body204400409
/token
Expand
POST
OAuth2 token endpoint
operationId: postToken
request body200400
/userinfo
Expand
GET
OIDC userinfo endpoint
operationId: getUserinfo
200401