Reference
Sign-in and session
The sign-in and session endpoints of the HTTP API.
GET /auth/login
Start the OIDC sign-in and redirect to the identity provider.
No authentication.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
return_to |
query | string |
Local path to return to after sign-in; anything else is replaced by /. |
Responses
| Status | Description | Body |
|---|---|---|
302 |
Redirect to the identity provider, or to /login?error=<code> when sign-in cannot start. |
GET /auth/callback
Complete the OIDC sign-in and redirect to the local return path.
No authentication.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
code |
query | string |
|
state |
query | string |
|
error |
query | string |
|
error_description |
query | string |
Responses
| Status | Description | Body |
|---|---|---|
302 |
Redirect to the return path with a session cookie, or to /login?error=<code> on refusal. |
POST /auth/logout
End the current session and clear its cookie.
No authentication.
Responses
| Status | Description | Body |
|---|---|---|
204 |
The session cookie is cleared; nothing is returned. | |
403 |
The caller is not allowed to perform the request; a role that is too low is code forbidden_role. |
Error |
500 |
The server failed to handle the request. | Error |
GET /auth/session
Report whether the request carries a valid session.
No authentication.
Responses
| Status | Description | Body |
|---|---|---|
200 |
The session state. | SessionState |
500 |
The server failed to handle the request. | Error |
GET /me
Return the authenticated caller.
Responses
| Status | Description | Body |
|---|---|---|
200 |
The caller. | Principal |
401 |
Authentication is missing or invalid. | Error |
500 |
The server failed to handle the request. | Error |
GET /instance
Return the server’s public and MCP URLs and its sign-in settings; never a secret.
Responses
| Status | Description | Body |
|---|---|---|
200 |
The URLs clients use to reach this server and who may sign in. | Instance |
401 |
Authentication is missing or invalid. | Error |
500 |
The server failed to handle the request. | Error |
Generated from api/openapi.yaml at bac0fe39. Report a problem.