v1

latestOpenAPI 3.0.02026-07-175652103.9 KB
login

OIDC State

This function is an API endpoint that checks the state of an OpenID Connect (OIDC) session. It is tagged with "login" for OpenAPI documentation.

Parameters

  • code: The authorization code received from the OIDC provider.

  • id: The identifier of the OIDC session.

  • uuid: The UUID of the OIDC session.

Returns

If successful, this function returns a Json<Option<OidcResponse>> object. <br> If the session does not exist, this function returns Json(None). <br>

Errors

This function will return an error if the system is in maintenance mode, or if the session does not exist.

Example

GET /api/oidc/auth-query?code=authorization_code&id=session_id&uuid=session_uuid

get/api/oidc/auth-query

Query parameters

codestring required
idstring required
uuidstring required

Response

access_tokenstring required
typestring required
tfa_typestring required
secretstring required