Skip to content
Vellum

Auth endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

POST /api/auth/register

Section titled “POST /api/auth/register”

Request body (application/json): RegisterRequest

Field Type Required Notes
email string yes
password string yes
displayName string or null yes
Status Meaning Body
200 OK none

GET /api/auth/methods

Section titled “GET /api/auth/methods”
Status Meaning Body
200 OK SignInMethodsResponse

POST /api/auth/login

Section titled “POST /api/auth/login”

Request body (application/json): LoginRequest

Field Type Required Notes
email string yes
password string yes
Status Meaning Body
200 OK none

POST /api/auth/logout

Section titled “POST /api/auth/logout”
Status Meaning Body
200 OK none

GET /api/auth/me

Section titled “GET /api/auth/me”
Status Meaning Body
200 OK none

GET /api/auth/external/{provider}

Section titled “GET /api/auth/external/{provider}”
Parameter In Type Required
provider path string yes
Status Meaning Body
200 OK none

GET /api/auth/external/complete

Section titled “GET /api/auth/external/complete”
Status Meaning Body
200 OK none