Skip to content
ReplicaDBReplicaDB

Create an authenticated session

POST
/api/v1/auth/login

Authenticates a user and establishes the server-owned session. Login is public and exempt from CSRF, but database-backed throttling limits repeated failures by account and source address.

Request Bodyrequired

Section titled “Request Bodyrequired”

Credentials used only to create a server-owned session.

object
password
required

Password accepted only for authentication and never returned.

string
username
required

ReplicaDB username.

string
Example
api-operator

Responses

Section titled “Responses”

200

Section titled “200”

Authenticated identity returned and session established

Identity associated with the current authenticated session.

object
id

User identifier.

string format: uuid
role

Global authorization role.

string
Allowed values: ADMIN OPERATOR VIEWER
username

Current username.

string

400

Section titled “400”

The request is malformed or fails validation.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference

401

Section titled “401”

Authentication is required or credentials are invalid.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference

429

Section titled “429”

The request is throttled after repeated authentication failures.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object
detail
string
instance
string format: uri-reference
status
integer format: int32
title
string
type
string format: uri-reference