POST v1/Users/Login
Logs a user in
Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Username |
The username of the user to login |
string |
Required |
| Password |
The password of the user to login |
string |
Required |
Response
APILogin| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionKey |
The Session Key for the user. This Session Key must be sent in the header of all subsequent calls. |
string |
None. |
| Username |
Username for the logged in user. |
string |
None. |
| SessionId |
Session Id |
integer |
None. |
| TwoFactorAuthenticationRequired |
True when Two Factor Authentication is required for this login |
boolean |
None. |
| Key | string |
None. |
Example
curl -d "Username={Username}&Password={Password}" -X POST https://api.creditriskmonitor.com/v1/Users/Login