1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/SecureBootDatabase.v1_0_3.json",
3    "$ref": "#/definitions/SecureBootDatabase",
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                "#SecureBootDatabase.ResetKeys": {
27                    "$ref": "#/definitions/ResetKeys"
28                },
29                "Oem": {
30                    "$ref": "#/definitions/OemActions",
31                    "description": "The available OEM-specific actions for this resource.",
32                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
33                }
34            },
35            "type": "object"
36        },
37        "OemActions": {
38            "additionalProperties": true,
39            "description": "The available OEM-specific actions for this resource.",
40            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
41            "patternProperties": {
42                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
43                    "description": "This property shall specify a valid odata or Redfish property.",
44                    "type": [
45                        "array",
46                        "boolean",
47                        "integer",
48                        "number",
49                        "null",
50                        "object",
51                        "string"
52                    ]
53                }
54            },
55            "properties": {},
56            "type": "object"
57        },
58        "ResetKeys": {
59            "additionalProperties": false,
60            "description": "This action is used to reset the UEFI Secure Boot keys of this database.",
61            "longDescription": "This action shall perform a reset of this UEFI Secure Boot key database.  The `ResetAllKeysToDefault` value shall reset this UEFI Secure Boot key database to the default values.  The `DeleteAllKeys` value shall delete the contents of this UEFI Secure Boot key database.",
62            "parameters": {
63                "ResetKeysType": {
64                    "$ref": "#/definitions/ResetKeysType",
65                    "description": "The type of reset or delete to perform on this UEFI Secure Boot database.",
66                    "longDescription": "This parameter shall specify the type of reset or delete to perform on this UEFI Secure Boot database.",
67                    "requiredParameter": true
68                }
69            },
70            "patternProperties": {
71                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
72                    "description": "This property shall specify a valid odata or Redfish property.",
73                    "type": [
74                        "array",
75                        "boolean",
76                        "integer",
77                        "number",
78                        "null",
79                        "object",
80                        "string"
81                    ]
82                }
83            },
84            "properties": {
85                "target": {
86                    "description": "Link to invoke action",
87                    "format": "uri-reference",
88                    "type": "string"
89                },
90                "title": {
91                    "description": "Friendly action name",
92                    "type": "string"
93                }
94            },
95            "type": "object"
96        },
97        "ResetKeysType": {
98            "enum": [
99                "ResetAllKeysToDefault",
100                "DeleteAllKeys"
101            ],
102            "enumDescriptions": {
103                "DeleteAllKeys": "Delete the contents of this UEFI Secure Boot key database.",
104                "ResetAllKeysToDefault": "Reset the contents of this UEFI Secure Boot key database to the default values."
105            },
106            "type": "string"
107        },
108        "SecureBootDatabase": {
109            "additionalProperties": false,
110            "description": "The `SecureBootDatabase` schema describes a UEFI Secure Boot database used to store certificates or hashes.",
111            "longDescription": "This resource shall be used to represent a UEFI Secure Boot database for a Redfish implementation.",
112            "patternProperties": {
113                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
114                    "description": "This property shall specify a valid odata or Redfish property.",
115                    "type": [
116                        "array",
117                        "boolean",
118                        "integer",
119                        "number",
120                        "null",
121                        "object",
122                        "string"
123                    ]
124                }
125            },
126            "properties": {
127                "@odata.context": {
128                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
129                },
130                "@odata.etag": {
131                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
132                },
133                "@odata.id": {
134                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
135                },
136                "@odata.type": {
137                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
138                },
139                "Actions": {
140                    "$ref": "#/definitions/Actions",
141                    "description": "The available actions for this resource.",
142                    "longDescription": "This property shall contain the available actions for this resource."
143                },
144                "Certificates": {
145                    "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection",
146                    "description": "A link to the collection of certificates contained in this UEFI Secure Boot database.",
147                    "longDescription": "The value of this property shall be a link to a resource collection of type `CertificateCollection`.",
148                    "readonly": true
149                },
150                "DatabaseId": {
151                    "description": "This property contains the name of the UEFI Secure Boot database.",
152                    "longDescription": "This property shall contain the name of the UEFI Secure Boot database.  This property shall contain the same value as the `Id` property.  The value shall be one of the UEFI-defined Secure Boot databases: `PK`, `KEK` `db`, `dbx`, `dbr`, `dbt`, `PKDefault`, `KEKDefault`, `dbDefault`, `dbxDefault`, `dbrDefault`, or `dbtDefault`.",
153                    "readonly": true,
154                    "type": "string"
155                },
156                "Description": {
157                    "anyOf": [
158                        {
159                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
160                        },
161                        {
162                            "type": "null"
163                        }
164                    ],
165                    "readonly": true
166                },
167                "Id": {
168                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
169                    "readonly": true
170                },
171                "Name": {
172                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
173                    "readonly": true
174                },
175                "Oem": {
176                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
177                    "description": "The OEM extension property.",
178                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
179                },
180                "Signatures": {
181                    "$ref": "http://redfish.dmtf.org/schemas/v1/SignatureCollection.json#/definitions/SignatureCollection",
182                    "description": "A link to the collection of signatures contained in this UEFI Secure Boot database.",
183                    "longDescription": "The value of this property shall be a link to a resource collection of type `SignatureCollection`.",
184                    "readonly": true
185                }
186            },
187            "required": [
188                "@odata.id",
189                "@odata.type",
190                "Id",
191                "Name"
192            ],
193            "type": "object"
194        }
195    },
196    "language": "en",
197    "owningEntity": "DMTF",
198    "release": "2020.1",
199    "title": "#SecureBootDatabase.v1_0_3.SecureBootDatabase"
200}