v1

latestOpenAPI 3.0.02026-07-175652103.9 KB
login

OIDC Auth Callback

This function is an API endpoint that serves as the OAuth2 callback. It exchanges the authorization code for an access token and stores it in the state. It is tagged with "login" for OpenAPI documentation.

Parameters

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

  • state: The state parameter received from the OIDC provider. This is the session code.

Returns

If successful, this function returns "OK". <br> If the session does not exist or the code exchange fails, this function returns "ERROR". <br>

Errors

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

Example

GET /api/oidc/callback?code=authorization_code&state=session_code

get/api/oidc/callback

Query parameters

codestring required
statestring required