Skip to main content

POST– Create a session

Create a session resource for further access authentications.

Request URL

POST https://<BMC_IPADDR>/redfish/v1/SessionService/Sessions

Request body

FieldTypeDescription

UserName

StringThe username who creates this session.

Password

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

Context

StringOptional. The additional context of this session.

Response body

FieldTypeDescription

UserName

StringThe username who creates this session.

Password

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

SessionType

String"Redfish"

Name

StringA session id value

Id

StringA session id value

Response header

FieldDescription

Location

Link to the session resource created.

X-Auth-Token

An authentication code is generated when a new session is created.

Status code

HTTP Status CodeError Message ID
201Created
401AccessDenied
503SessionLimitExceeded
500InternalError