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

UserName

String

The username who creates this session.

Password

String

This property is used in a POST to specify a password when creating a new session. This property is null on a GET.

SessionType

String

Session Type string and it is depended on the session type (ex. Redfish, WebGUI, ManagerConsole … etc.)

Note
On Purley platforms, only Redfish sessions are supported.

Name

String

A session id value.

Id

String

A session id value.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON responses are returned:

Redfish session
{
    "@odata.id": "/redfish/v1/SessionService/Sessions/6",
    "Password": null,
    "@odata.type": "#Session.v1_2_1.Session",
    "Id": "6",
    "SessionType": "Redfish",
    "@odata.etag": "\"1470b92b471825a097d\"",
    "Name": "6",
    "UserName": "USERID"
}

WebUI session
{
    "@odata.id": "/redfish/v1/SessionService/Sessions/7",
    "Password": null,
    "@odata.type": "#Session.v1_2_1.Session",
    "Id": "7",
    "SessionType": "WebUI",
    "@odata.etag": "\"142a4e178c5a2420877\"",
    "Name": "7",
    "UserName": "USERID"
}

CLI session
{
    "@odata.id": "/redfish/v1/SessionService/Sessions/8",
    "Password": null,
    "@odata.type": "#Session.v1_2_1.Session",
    "Id": "8",
    "SessionType": "ManagerConsole",
    "@odata.etag": "\"1647efec331f2ae0c4c\"",
    "Name": "8",
    "UserName": "USERID"
}