xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/SessionService.v1_2_0.json (revision 9b46bc0b4c0c58c426e9bfb5a7d90250862ca9d2)
1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/SessionService.v1_2_0.json",
3    "$ref": "#/definitions/SessionService",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6    "definitions": {
7        "Actions": {
8            "additionalProperties": false,
9            "description": "The available actions for this resource.",
10            "longDescription": "This type shall contain the available actions for this resource.",
11            "patternProperties": {
12                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13                    "description": "This property shall specify a valid odata or Redfish property.",
14                    "type": [
15                        "array",
16                        "boolean",
17                        "integer",
18                        "number",
19                        "null",
20                        "object",
21                        "string"
22                    ]
23                }
24            },
25            "properties": {
26                "Oem": {
27                    "$ref": "#/definitions/OemActions",
28                    "description": "The available OEM-specific actions for this resource.",
29                    "longDescription": "This property shall contain the available OEM-specific actions for this resource.",
30                    "versionAdded": "v1_1_0"
31                }
32            },
33            "type": "object"
34        },
35        "OemActions": {
36            "additionalProperties": true,
37            "description": "The available OEM-specific actions for this resource.",
38            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
39            "patternProperties": {
40                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
41                    "description": "This property shall specify a valid odata or Redfish property.",
42                    "type": [
43                        "array",
44                        "boolean",
45                        "integer",
46                        "number",
47                        "null",
48                        "object",
49                        "string"
50                    ]
51                }
52            },
53            "properties": {},
54            "type": "object"
55        },
56        "SessionService": {
57            "additionalProperties": false,
58            "description": "The `SessionService` schema describes the session service and its properties, with links to the actual list of sessions.",
59            "longDescription": "This resource contains the session service properties for a Redfish implementation.",
60            "patternProperties": {
61                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
62                    "description": "This property shall specify a valid odata or Redfish property.",
63                    "type": [
64                        "array",
65                        "boolean",
66                        "integer",
67                        "number",
68                        "null",
69                        "object",
70                        "string"
71                    ]
72                }
73            },
74            "properties": {
75                "@odata.context": {
76                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
77                },
78                "@odata.etag": {
79                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
80                },
81                "@odata.id": {
82                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
83                },
84                "@odata.type": {
85                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
86                },
87                "AbsoluteSessionTimeout": {
88                    "description": "The maximum number of seconds that a session is open before the service closes the session regardless of activity.",
89                    "longDescription": "This property shall contain the maximum number of seconds that a session is open before the service closes the session regardless of activity.",
90                    "maximum": 86400,
91                    "minimum": 30,
92                    "readonly": false,
93                    "type": "integer",
94                    "units": "s",
95                    "versionAdded": "v1_2_0"
96                },
97                "AbsoluteSessionTimeoutEnabled": {
98                    "description": "An indication of whether an absolute session timeout is applied to sessions.",
99                    "longDescription": "This property shall indicate whether an absolute session timeout is applied to sessions.  If `true`, the service shall close sessions that are open for the number of seconds specified by the `AbsoluteSessionTimeout` property regardless of session activity.  If `false` or if this property is not present, the service shall not apply an absolute session timeout.",
100                    "readonly": false,
101                    "type": "boolean",
102                    "versionAdded": "v1_2_0"
103                },
104                "Actions": {
105                    "$ref": "#/definitions/Actions",
106                    "description": "The available actions for this resource.",
107                    "longDescription": "This property shall contain the available actions for this resource.",
108                    "versionAdded": "v1_1_0"
109                },
110                "Description": {
111                    "anyOf": [
112                        {
113                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
114                        },
115                        {
116                            "type": "null"
117                        }
118                    ],
119                    "readonly": true
120                },
121                "Id": {
122                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
123                    "readonly": true
124                },
125                "Name": {
126                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
127                    "readonly": true
128                },
129                "Oem": {
130                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
131                    "description": "The OEM extension property.",
132                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
133                },
134                "ServiceEnabled": {
135                    "description": "An indication of whether this service is enabled.  If `true`, this service is enabled.  If `false`, it is disabled, and new sessions cannot be created, old sessions cannot be deleted, and established sessions can continue operating.",
136                    "longDescription": "This property shall indicate whether this service is enabled.  If `true`, this service is enabled.  If `false`, it is disabled, and new sessions shall not be created, old sessions shall not be deleted, and established sessions can continue operating.",
137                    "readonly": false,
138                    "type": [
139                        "boolean",
140                        "null"
141                    ]
142                },
143                "SessionTimeout": {
144                    "description": "The number of seconds of inactivity that a session can have before the session service closes the session due to inactivity.",
145                    "longDescription": "This property shall contain the threshold of time in seconds between requests on a specific session at which point the session service shall close the session due to inactivity.  The session service shall support any value between the schema-specified minimum and maximum terms.",
146                    "maximum": 86400,
147                    "minimum": 30,
148                    "readonly": false,
149                    "type": "integer",
150                    "units": "s"
151                },
152                "Sessions": {
153                    "$ref": "http://redfish.dmtf.org/schemas/v1/SessionCollection.json#/definitions/SessionCollection",
154                    "description": "The link to a collection of sessions.",
155                    "longDescription": "This property shall contain a link to a resource collection of type `SessionCollection`.",
156                    "readonly": true
157                },
158                "Status": {
159                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
160                    "description": "The status and health of the resource and its subordinate or dependent resources.",
161                    "longDescription": "This property shall contain any status or health properties of the resource."
162                }
163            },
164            "required": [
165                "@odata.id",
166                "@odata.type",
167                "Id",
168                "Name"
169            ],
170            "type": "object"
171        }
172    },
173    "language": "en",
174    "owningEntity": "DMTF",
175    "release": "2024.4",
176    "title": "#SessionService.v1_2_0.SessionService"
177}