Modifying Session Service Information

Function

This interface is used to modify information about a session service.

Syntax

Operation type: PATCH

URL: https://device_ip/redfish/v1/SessionService

Request header:

X-Auth-Token: auth_value
Content-Type: header_type

Request message body:

{
    "SessionTimeout": sessiontimeout,
    "Password": password
}

Request Parameters

**Table 1** Request parameters
Parameter	Mandatory/Optional	Parameter Description	Value
SessionTimeout	Mandatory	Timeout interval of a Redfish session.	The value is a number ranging from 5 to 120, in minutes.
Password	Mandatory	Password of the current user.	The value is a string of 8 to 20 characters. The password complexity check is enabled by default. The password must meet password complexity requirements.

Usage Guidelines

None

Example

Request:

PATCH https://10.10.10.10/redfish/v1/SessionService

Request header:

X-Auth-Token: auth_value 
Content-Type: application/json

Request message body:

{
    "SessionTimeout":16,
    "Password":"password"
}

Response:

{
    "@odata.context": "/redfish/v1/$metadata#SessionService",
    "@odata.id": "/redfish/v1/SessionService",
    "@odata.type": "#SessionService.v1_1_8.SessionService",
    "Id": "SessionService",
    "Name": "Session Service",
    "SessionTimeout": 16,
    "Sessions": {
        "@odata.id": "/redfish/v1/SessionService/Sessions"
    }
}

Response code: 200

Output Description

**Table 2** Operation output description
Field	Type	Description
@odata.context	Character string	OData description of the current service resource model.
@odata.id	Character string	Path to access the current service resource node.
@odata.type	Character string	Type of the current service resource.
Id	Character string	ID of the current service resource.
Name	Character string	Name of the current service resource.
SessionTimeout	Number	Timeout interval of a Redfish session.
Sessions	Object	List of sessions.
@odata.id	Character string	Path to access the session list.

Parent topic: User Management