Skip to main content

GET – Session properties

Use the GET method to retrieve properties in Session resource for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/SessionService/Sessions/{1...N}

Request body​

None

Response body​

FieldTypeDescription
UserNameStringThe username who creates this session.
PasswordStringThis property is used in a POST to specify a password when creating a new session. This property is null on a GET.
SessionTypeStringSession Type string and it is depended on the session type (ex. Redfish, WebGUI, ManagerConsole … etc.)
NameStringA session id value
IdStringA session id value
CreatedTimeStringThe time when created this session
ContextStringEmpty string

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON responses are returned:

Redfish session
{
    "@odata.etag": "\"1d865beb2183242428c\"",
    "Password": null,
    "UserName": "SYSMGR_ZV5RSYO9",
    "Id": "287",
    "Name": "287",
    "@odata.type": "#Session.v1_5_0.Session",
    "@odata.id": "/redfish/v1/SessionService/Sessions/287",
    "@odata.context": "/redfish/v1/$metadata#Session.Session",
    "Context": "",
    "SessionType": "Redfish",
    "CreatedTime": "2023-10-18T09:09:15+00:00",
    "Oem": {
        "Lenovo": {}
    }
}

WebUI session

{
    "@odata.etag": "\"1cbdd6d133ab2ae2c89\"",
    "Password": null,
    "UserName": "USERID",
    "Id": "238",
    "Name": "238",
    "@odata.type": "#Session.v1_5_0.Session",
    "@odata.id": "/redfish/v1/SessionService/Sessions/238",
    "@odata.context": "/redfish/v1/$metadata#Session.Session",
    "Context": "",
    "CreatedTime": "2023-10-18T06:03:40+00:00",
    "SessionType": "WebUI",
    "Oem": {
        "Lenovo": {}
    }
}

CLI session
{
    "@odata.id": "/redfish/v1/SessionService/Sessions/8",
    "Password": null,
    "@odata.type": "#Session.v1_3_0.Session",
    "Id": "8",
    "SessionType": "ManagerConsole",
    "@odata.etag": "\"1647efec331f2ae0c4c\"",
    "Name": "8",
    "UserName": "USERID",
    "CreatedTime": "2023-10-18T06:03:40+00:00",
      "SessionType": "WebUI",
      "Oem": {
           "Lenovo": {}
    }

}