auth response models
Generated file. Do not edit by hand. Regenerate from the repo root with
CGO_ENABLED=0 go run scripts/gen-response-models-md.go.
Part of the API response model reference, which explains the Response model and Origin columns. Route inventory: routes.md. Named payload structs: payload-shapes.md.
| Method | Path | Response model | Origin |
|---|---|---|---|
POST | /api/auth/backchannel-logout | machine-only OIDC Back-Channel Logout 1.0 §2.8 notification, POSTed BY Keycloak and never an operator API, so no client method is generated. NOT the API envelope: 200 + Cache-Control: no-store on a verified logout token; 400 {error, error_description} when the token is missing, malformed or fails validation; 503 when the daemon cannot verify right now (a token we could not CHECK is not a token known to be bad, so 503 keeps Keycloak’s retry alive). The request body is form-encoded logout_token, which invokeJSON cannot express | annotation |
GET | /api/auth/ca | global-root CA certificate PEM (text body) | annotation |
GET | /api/auth/forward-auth | ForwardAuthDecision | handler |
POST | /api/auth/identity-provider | IdentityProvider | handler |
DELETE | /api/auth/identity-provider/{tenant}/{alias} | IdentityProviderIdentity | handler |
GET | /api/auth/identity-provider/{tenant}/{alias} | IdentityProvider | handler |
PUT | /api/auth/identity-provider/{tenant}/{alias} | IdentityProvider | handler |
GET | /api/auth/lan-refusal | machine-only page a LAN-only deployment’s router fetches for a visitor its allowlist refused (SHC-408), so no client method is generated. NOT the API envelope: always 403 with Cache-Control: no-store; a request whose Accept names text/html gets an HTML page naming the requested host and saying the network is why, any other gets the allowlist’s own text/plain body Forbidden | annotation |
POST | /api/auth/ldap-bind | LDAPBind | handler |
DELETE | /api/auth/ldap-bind/{tenant}/{name} | LDAPBindDeleteResponse | handler |
GET | /api/auth/ldap-binds | []LDAPBindInfo | handler |
POST | /api/auth/oidc-client | OIDCClientCreated | handler |
DELETE | /api/auth/oidc-client/{tenant}/{clientId} | OIDCClientIdentity | handler |
GET | /api/auth/oidc-client/{tenant}/{clientId} | OIDCClient | handler |
PUT | /api/auth/oidc-client/{tenant}/{clientId} | OIDCClient | handler |
GET | /api/auth/oidc/discovery | OIDCRealmResponse | handler |
GET | /api/auth/oidc/realm | OIDCRealmResponse | handler |
GET | /api/auth/oidc/realm-for-host | OIDCRealmResponse | handler |
POST | /api/auth/service-client | ServiceClientResponse | handler |
DELETE | /api/auth/service-client/{name} | ServiceClientDeleteResponse | handler |
GET | /api/auth/service-clients | []ServiceClientInfo | handler |
POST | /api/auth/session-revoke | machine-only RP-initiated-logout revocation, POSTed BY the forward-auth sidecar at the start of a logout with the credential it is retiring (shc_access_token cookie or bearer) plus X-SHC-Forward-Auth-Secret. It is never an operator API, so no client method is generated. NOT the API envelope: 200 {revoked: 1} when the session is now in the revocation ledger, 200 {revoked: 0} when the credential was already dead by the gate’s own rules (expired, unparseable, foreign issuer/audience) so nothing admissible survives, and 503 {error, error_description} when the daemon COULD NOT DECIDE (no JWKS authority, an unverifiable credential, or a durable ledger write that was refused). The sidecar turns every non-200 into a 502 with no redirect to Keycloak: a logout that could not revoke must not be reported as a logout | annotation |
shc@docs:~$