Initiate User Session
This request authenticates the user.
Authorizations: All
Requests
POST /apis/authentication/login { |
Response
Example:
{ |
Caution
This data is informational only and subject to change in future HMP releases. The User Session resource is a private resource in HMP v2.5.REST API developers are encouraged to check for a 200 OK
status to verify that a session is valid, but otherwise ignore this response. REST API applications that use the data from this response may stop functioning and break user logins if this response is changed.
A calypso-session-id
cookie is returned via the Set-Cookie HTTP header. This cookie is used to authenticate the user for all subsequent requests.
Error
Code | Payload | Description |
---|---|---|
400 | {"code":"010001","name":"InputValidation", | A user name or password was missing or the wrong JSON type. |
401 | {"code":"020001","name":"UserNotAuthorized", | User has no role assigned. |
401 | {"code":"020002","name":"InvalidCredentials", | The user name and or the password was incorrect. |
500 | {"code":"070051","name":"CreateUserSessi on", | An internal error occurred. |
500 | {"code":"070000","name":"InternalServer", | An internal error occurred. |
503 | {"code":"090002","name":"ServiceUnavailable", | Authentication service is unavailable. Please try again later. |