Skip to content

Create Session

POST /api/v1/auth/login

The contract allows this request without an existing authenticated session.

Authentication and permissions explains tokens, cookies, CSRF, and workspace context.

Required.

application/json — LoginBody.

Field Type Required Description and constraints
username string Yes minimum length 3. maximum length 64
password string Yes minimum length 1. maximum length 128
totpCode string or null No
recoveryCode string or null No

Set the connection variables described in Get started. Replace each additional EOI_… variable with the parameter value for this request. Prepare the body file using the request schema above. This template sends the request when run.

Terminal window
curl --fail-with-body --silent --show-error \
--request POST \
--cookie-jar "${EOI_COOKIE_JAR}" \
--header "Content-Type: application/json" \
--data-binary @request.json \
"${EOI_API_BASE_URL}/auth/login"

The table records responses declared by the OpenAPI contract. See Errors and status codes for the runtime error envelope and shared failures.

Status Description Media type Body
200 Successful Response application/json SessionLoginResponse
422 Validation Error application/json HTTPValidationError

Operation identifier createSession. Browse Authentication and sessions.

Image preview