/api/v2/login

POST {{butlr_api_url}}/api/v2/login

Authenticate a user and obtain access, refresh, and ID tokens.

Headers
KeyValue
Content-Typeapplication/json
Body
ParameterTypeDescriptionRequired
usernamestringThe user's email address.Yes
passwordstringThe user's password.Yes

Response

Success (200 OK)

Body
ParameterTypeDescription
access_tokenstringThe access token to be used for subsequent authenticated calls.
refresh_tokenstringThe token to be used to obtain a new access token.
id_tokenstringThe ID token containing user profile information.
scopestringThe scopes associated with the access token.
expires_inintThe time (in seconds) until the access token expires.
token_typestringThe token type, which is usually Bearer.

Request Body

{"username"=>"{{username}}", "password"=>"{{password}}"}