1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/Role.v1_3_2.json",
3    "$ref": "#/definitions/Role",
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        "Role": {
57            "additionalProperties": false,
58            "description": "The `Role` schema contains a Redfish role to use in conjunction with a manager account.",
59            "longDescription": "This resource shall represent the Redfish role for the user account.",
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                "Actions": {
88                    "$ref": "#/definitions/Actions",
89                    "description": "The available actions for this resource.",
90                    "longDescription": "This property shall contain the available actions for this resource.",
91                    "versionAdded": "v1_1_0"
92                },
93                "AlternateRoleId": {
94                    "description": "An equivalent role to use when this role is restricted.",
95                    "longDescription": "This property shall contain a non-restricted `RoleId` intended to be used in its place when the `Restricted` property contains the value `true`.",
96                    "readonly": true,
97                    "type": "string",
98                    "versionAdded": "v1_3_0"
99                },
100                "AssignedPrivileges": {
101                    "description": "The Redfish privileges for this role.",
102                    "items": {
103                        "$ref": "http://redfish.dmtf.org/schemas/v1/Privileges.json#/definitions/PrivilegeType"
104                    },
105                    "longDescription": "This property shall contain the Redfish privileges for this role.  For predefined roles, this property shall be read-only.  For custom roles, some implementations may prevent writing to this property.",
106                    "readonly": false,
107                    "type": "array"
108                },
109                "Description": {
110                    "anyOf": [
111                        {
112                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
113                        },
114                        {
115                            "type": "null"
116                        }
117                    ],
118                    "readonly": true
119                },
120                "Id": {
121                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
122                    "readonly": true
123                },
124                "IsPredefined": {
125                    "description": "An indication of whether the role is predefined by Redfish or an OEM rather than a client-defined role.",
126                    "longDescription": "This property shall indicate whether the role is predefined by Redfish or an OEM as contrasted with a client-defined role.",
127                    "readonly": true,
128                    "type": "boolean"
129                },
130                "Name": {
131                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
132                    "readonly": true
133                },
134                "Oem": {
135                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
136                    "description": "The OEM extension property.",
137                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
138                },
139                "OemPrivileges": {
140                    "description": "The OEM privileges for this role.",
141                    "items": {
142                        "type": "string"
143                    },
144                    "longDescription": "This property shall contain the OEM privileges for this role.  For predefined roles, this property shall be read-only.  For custom roles, some implementations may prevent writing to this property.",
145                    "readonly": false,
146                    "type": "array"
147                },
148                "Restricted": {
149                    "description": "An indication of whether use of the role is restricted.",
150                    "longDescription": "This property shall indicate whether use of the role is restricted by a service as defined by the 'Restricted roles and restricted privileges' clause of the Redfish Specification.  If this property is not present, the value shall be assumed to be `false`.",
151                    "readonly": true,
152                    "type": "boolean",
153                    "versionAdded": "v1_3_0"
154                },
155                "RoleId": {
156                    "description": "The name of the role.",
157                    "longDescription": "This property shall contain the string name of the role.  This property shall contain the same value as the `Id` property.",
158                    "readonly": true,
159                    "type": "string",
160                    "versionAdded": "v1_2_0"
161                }
162            },
163            "required": [
164                "@odata.id",
165                "@odata.type",
166                "Id",
167                "Name"
168            ],
169            "requiredOnCreate": [
170                "RoleId"
171            ],
172            "type": "object"
173        }
174    },
175    "language": "en",
176    "owningEntity": "DMTF",
177    "release": "2020.4",
178    "title": "#Role.v1_3_2.Role"
179}