Get User Session Info

Gets information about the user session for the calypso-session-id cookie included in the request headers.

Authorizations: All

Requests

GET /apis/authentication/login

Response

Example:

{ "data": {
    "id": null,
    "sessionId": "b34f71d6-d0b2-470a-9aeb-43ba7a3bb831",
    "username": "haiadmin",
    "admin": true,
    "groups": [],
    "roleIds": [],
    "roles": [
      {
        "id": "admin",
        "name": "Administrator",
        "admin": true,
        "permissions": {}
      }],
    "sessions": {},
    "assets": {},
    "ldapUser": false,
    "displayName": "haiadmin",
    "expires": "2014-05-01T17:50:24.019Z"
  }}

Caution

This data is informational only and subject to change. The User Session resource is not a defined resource with full support 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.

Error

Code	Payload	Description
401	{"code":"020001", "name":"UserNotAuthorized", "message":"User is not authorized", "httpStatusCode":401}	User is not authenticated.