Skip to content
SHC Docs

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.

MethodPathResponse modelOrigin
POST/api/auth/backchannel-logoutmachine-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 expressannotation
GET/api/auth/caglobal-root CA certificate PEM (text body)annotation
GET/api/auth/forward-authForwardAuthDecisionhandler
POST/api/auth/identity-providerIdentityProviderhandler
DELETE/api/auth/identity-provider/{tenant}/{alias}IdentityProviderIdentityhandler
GET/api/auth/identity-provider/{tenant}/{alias}IdentityProviderhandler
PUT/api/auth/identity-provider/{tenant}/{alias}IdentityProviderhandler
GET/api/auth/lan-refusalmachine-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 Forbiddenannotation
POST/api/auth/ldap-bindLDAPBindhandler
DELETE/api/auth/ldap-bind/{tenant}/{name}LDAPBindDeleteResponsehandler
GET/api/auth/ldap-binds[]LDAPBindInfohandler
POST/api/auth/oidc-clientOIDCClientCreatedhandler
DELETE/api/auth/oidc-client/{tenant}/{clientId}OIDCClientIdentityhandler
GET/api/auth/oidc-client/{tenant}/{clientId}OIDCClienthandler
PUT/api/auth/oidc-client/{tenant}/{clientId}OIDCClienthandler
GET/api/auth/oidc/discoveryOIDCRealmResponsehandler
GET/api/auth/oidc/realmOIDCRealmResponsehandler
GET/api/auth/oidc/realm-for-hostOIDCRealmResponsehandler
POST/api/auth/service-clientServiceClientResponsehandler
DELETE/api/auth/service-client/{name}ServiceClientDeleteResponsehandler
GET/api/auth/service-clients[]ServiceClientInfohandler
POST/api/auth/session-revokemachine-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 logoutannotation