Login

Password-based login

post

Starts a session given a username/password and puts it into a cookie.

Body

application/json

Bundles a username/password for authentication purposes.

usernamestringRequired

passwordstring · passwordRequired

redirection_tokenstringOptional

Responses

200

Happy response.

application/json

Contains the response for successful login.

redir_tostringOptional

Optionally contains a relative URL (path, query) where to redirect to. One application of this property is resuming an OAuth2 authorization flow.

default

Error object.

application/json

post/api/v1/login

HTTPcURLJavaScriptPython

POST /api/v1/login HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "username": "text",
  "password": "password",
  "redirection_token": "text"
}

{
  "redir_to": "text"
}