summaryrefslogtreecommitdiff
path: root/static/redfish/v1/JsonSchemas/PrivilegeRegistry/PrivilegeRegistry.json
blob: 596100fc18409e62da868723f62d59f0dc175ffc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
{
    "$ref": "#/definitions/PrivilegeRegistry",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "This property contains the available OEM specific actions for this resource.",
                    "longDescription": "This property shall contain any additional OEM actions for this resource."
                }
            },
            "type": "object"
        },
        "Mapping": {
            "additionalProperties": false,
            "description": "This type describes a mapping between an entity and the relevant privileges used to access it.",
            "longDescription": "This type shall describe a mapping between an entity and the relevant privileges used to access it.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Entity": {
                    "description": "Indicates entity name. e.g., Manager.",
                    "longDescription": "Indicates entity name. e.g., Manager.",
                    "readonly": true,
                    "type": "string"
                },
                "OperationMap": {
                    "$ref": "#/definitions/OperationMap",
                    "description": "List mapping between HTTP method and privilege required for entity.",
                    "longDescription": "List mapping between HTTP method and privilege required for entity."
                },
                "PropertyOverrides": {
                    "description": "Indicates privilege overrides of property or element within a entity.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/Target_PrivilegeMap"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "Indicates privilege overrides of property or element. e.g., password property.",
                    "type": "array"
                },
                "ResourceURIOverrides": {
                    "description": "Indicates privilege overrides of Resource URI.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/Target_PrivilegeMap"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "Indicates privilege overrides of Resource URI. Target lists Resource URI.",
                    "type": "array"
                },
                "SubordinateOverrides": {
                    "description": "Indicates privilege overrides of subordinate resource.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/Target_PrivilegeMap"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "Indicates privilege overrides of subordinate resource. Target lists referenced by Entity.",
                    "type": "array"
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM specific actions for this resource.",
            "longDescription": "This type shall contain any additional OEM actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        },
        "OperationMap": {
            "additionalProperties": false,
            "description": "Used for describing the specific privileges for a set of HTTP operations.",
            "longDescription": "This type shall describe the specific privileges required for a set of HTTP operations.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "DELETE": {
                    "description": "Indicates privilege required for HTTP DELETE operation.",
                    "items": {
                        "$ref": "#/definitions/OperationPrivilege"
                    },
                    "longDescription": "Indicates privilege required for HTTP DELETE operation.",
                    "type": "array"
                },
                "GET": {
                    "description": "Indicates privilege required for HTTP GET operation.",
                    "items": {
                        "$ref": "#/definitions/OperationPrivilege"
                    },
                    "longDescription": "Indicates privilege required for HTTP GET operation.",
                    "type": "array"
                },
                "HEAD": {
                    "description": "Indicates privilege required for HTTP HEAD operation.",
                    "items": {
                        "$ref": "#/definitions/OperationPrivilege"
                    },
                    "longDescription": "Indicates privilege required for HTTP HEAD operation.",
                    "type": "array"
                },
                "PATCH": {
                    "description": "Indicates privilege required for HTTP PATCH operation.",
                    "items": {
                        "$ref": "#/definitions/OperationPrivilege"
                    },
                    "longDescription": "Indicates privilege required for HTTP PATCH operation.",
                    "type": "array"
                },
                "POST": {
                    "description": "Indicates privilege required for HTTP POST operation.",
                    "items": {
                        "$ref": "#/definitions/OperationPrivilege"
                    },
                    "longDescription": "Indicates privilege required for HTTP POST operation.",
                    "type": "array"
                },
                "PUT": {
                    "description": "Indicates privilege required for HTTP PUT operation.",
                    "items": {
                        "$ref": "#/definitions/OperationPrivilege"
                    },
                    "longDescription": "Indicates privilege required for HTTP PUT operation.",
                    "type": "array"
                }
            },
            "type": "object"
        },
        "OperationPrivilege": {
            "additionalProperties": false,
            "description": "Used for describing the specific privileges for a given type of HTTP operation.",
            "longDescription": "This type shall describe the specific privileges required for a given type of HTTP operation.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Privilege": {
                    "description": "Lists the privileges that are allowed to perform the given type of HTTP operation on the entity type.",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This array shall contain a set of strings that match 0 or more of the strings found in the PrivilegesUsed and OEMPrivilegesUsed properties.",
                    "readonly": true,
                    "type": "array"
                }
            },
            "type": "object"
        },
        "PrivilegeRegistry": {
            "additionalProperties": false,
            "description": "This is the schema definition for Operation to Privilege mapping.",
            "longDescription": "This resource shall be used to represent operation to privilege mappings.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "The Actions property shall contain the available actions for this resource."
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Mappings": {
                    "description": "This property describes the mappings between entities and the relevant privileges used to access them.",
                    "items": {
                        "$ref": "#/definitions/Mapping"
                    },
                    "longDescription": "This property shall describe the mappings between entities and the relevant privileges used to access them.",
                    "type": "array"
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "OEMPrivilegesUsed": {
                    "description": "Lists the set of OEM Priviliges used in building this mapping.",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This property shall be an array that contains the set of OEM Priviliges used in building this mapping.",
                    "readonly": true,
                    "type": "array"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
                    "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
                },
                "PrivilegesUsed": {
                    "description": "Lists the set of Redfish standard priviliges used in building this mapping.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Privileges.json#/definitions/PrivilegeType"
                    },
                    "longDescription": "This property shall be an array that contains the set of Redfish standard priviliges used in building this mapping.",
                    "readonly": true,
                    "type": "array"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "Target_PrivilegeMap": {
            "additionalProperties": false,
            "description": "This type describes a mapping between one or more targets and the HTTP operations associated with them.",
            "longDescription": "This type shall describe a mapping between one or more targets and the HTTP operations associated with them.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "OperationMap": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/OperationMap"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "List mapping between HTTP operation and privilege needed to perform operation.",
                    "longDescription": "List mapping between HTTP operation and privilege needed to perform operation."
                },
                "Targets": {
                    "description": "Indicates the URI or Entity.",
                    "items": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "longDescription": "Indicates the set of URI(s) or Entity(s) or property(s). e.g./redfish/v1/Systems/1, Manager, Password. When targets property is not mentioned, then there is no override.",
                    "readonly": true,
                    "type": "array"
                }
            },
            "type": "object"
        }
    },
    "owningEntity": "DMTF",
    "title": "#PrivilegeRegistry.v1_1_2.PrivilegeRegistry"
}