POST/v1/user/login

Authenticate with login credentials

Authenticates a user by validating username and password credentials. Send the credentials as application/x-www-form-urlencoded; a successful response contains a bearer token for REST API authentication.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

Form-encoded login credentials.

passwordstringoptional
The user's password.
usernamestringoptional
The username to authenticate.

3 status codes
200Returns a bearer token to use when authenticating with the REST API.
401Returned when the request is unauthorized.
403Returned when the request is forbidden.

Error handling

A 401 is returned when the credentials are not accepted. A 403 indicates that the request is forbidden; submit the username and password as form fields.