POST Session/Login
Login and obtain an AccessToken and RefreshToken
Request Information
URI Parameters
None.
Body Parameters
The LoginDto
LoginDto| Name | Description | Type | Additional information |
|---|---|---|---|
| client_id |
The API client id |
string |
None. |
| client_secret |
The API client secret |
string |
None. |
| system_id |
The system id related to the used API credentials (leave empty if unknown) |
string |
None. |
| username |
The username |
string |
None. |
| password |
The password |
string |
None. |
| user_token |
an (optional) user token |
string |
None. |
| user_token_type |
The type of the user token When null assumes the caller can't do user tokens and will return a failed authorizaton when MFA is required When not null assumes the caller can do user tokens and will return an enhanced login result dto with info about MFA required |
LoginUserTokenType |
None. |
Response Information
Resource Description
LoginResultDto| Name | Description | Type | Additional information |
|---|---|---|---|
| token_type |
Bearer |
string |
None. |
| access_token |
The access token to authenticate requests |
string |
None. |
| refresh_token |
The refresh token to obtain a new access token |
string |
None. |
| expires_in |
The remaining lifetime of the access token in seconds |
decimal number |
None. |
| login_result_type |
the result of the login operation, indicating if login was successful or a reason why it was not |
LoginResultType |
None. |