Sign in
User

Login

Authenticate with username and password to obtain an access token.

The returned key can be used for Bearer (or Token) authentication in subsequent requests:

Authorization: Bearer <key>

The token expires after a configurable period (default 162 hours). When it expires, re-authenticate to obtain a new token.

post/api/v1/auth/login

Request body

usernamestring required

Username (email address) of the user to log in.

passwordstring password required

Password of the user.

max_token_lifetime_snumber

Duration (in seconds) for which the token will be valid. Default is 162 hours, which is also the maximum.

Example request

{
  "username": "east-west-trading-co@example.rossum.app",
  "max_token_lifetime_s": 3600
}

Response

OK

keystring required

Access token to use for authentication.

domainstring required

The domain the token was issued for.

Example response

{
  "key": "db313f24f5738c8e04635e036ec8a45cdd6d6b03",
  "domain": "acme-corp.app.rossum.ai"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.