blob: 5fabf01b41679bb6b3b25acdbb7dcebe2ecf46eb [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Gunnar Mills262d7d42021-01-20 16:28:41 -06004<!--# Redfish Schema: Role v1.3.0 -->
Jason M. Billsea4aa752018-06-05 13:29:11 -07005<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
Gunnar Millsa778c022020-05-12 12:20:36 -05008<!--# Copyright 2014-2020 DMTF. -->
Jason M. Billsea4aa752018-06-05 13:29:11 -07009<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
21 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
24 <edmx:Include Namespace="Resource.v1_0_0"/>
25 </edmx:Reference>
26 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Privileges_v1.xml">
27 <edmx:Include Namespace="Privileges"/>
28 </edmx:Reference>
29
30 <edmx:DataServices>
31
32 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role">
33 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
34
35 <EntityType Name="Role" BaseType="Resource.v1_0_0.Resource" Abstract="true">
Gunnar Mills844b4152020-06-22 12:44:09 -050036 <Annotation Term="OData.Description" String="The Role schema contains a Redfish role to use in conjunction with a manager account."/>
37 <Annotation Term="OData.LongDescription" String="This resource represents the Redfish role for the user account."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070038 <Annotation Term="Capabilities.InsertRestrictions">
39 <Record>
40 <PropertyValue Property="Insertable" Bool="false"/>
41 </Record>
42 </Annotation>
43 <Annotation Term="Capabilities.UpdateRestrictions">
44 <Record>
45 <PropertyValue Property="Updatable" Bool="true"/>
Gunnar Mills844b4152020-06-22 12:44:09 -050046 <Annotation Term="OData.Description" String="Various privileges can be updated for roles."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070047 </Record>
48 </Annotation>
49 <Annotation Term="Capabilities.DeleteRestrictions">
50 <Record>
51 <PropertyValue Property="Deletable" Bool="false"/>
52 </Record>
53 </Annotation>
Ed Tanous530520e2019-01-02 13:41:37 -080054 <Annotation Term="Redfish.Uris">
55 <Collection>
56 <String>/redfish/v1/AccountService/Roles/{RoleId}</String>
57 <String>/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Roles/{RoleId}</String>
58 </Collection>
59 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -070060 </EntityType>
Jason M. Billsea4aa752018-06-05 13:29:11 -070061 </Schema>
62
63 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_0_0">
64 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060065 <Annotation Term="Redfish.Release" String="1.0"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070066
67 <EntityType Name="Role" BaseType="Role.Role">
Jason M. Billsea4aa752018-06-05 13:29:11 -070068 <Property Name="IsPredefined" Type="Edm.Boolean" Nullable="false" DefaultValue="false">
69 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills262d7d42021-01-20 16:28:41 -060070 <Annotation Term="OData.Description" String="An indication of whether the role is predefined by Redfish or an OEM rather than a client-defined role."/>
71 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the role is predefined by Redfish or an OEM as contrasted with a client-defined role."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070072 </Property>
73 <Property Name="AssignedPrivileges" Type="Collection(Privileges.PrivilegeType)" Nullable="false">
74 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills844b4152020-06-22 12:44:09 -050075 <Annotation Term="OData.Description" String="The Redfish privileges for this role."/>
76 <Annotation Term="OData.LongDescription" String="This property shall contain the Redfish privileges for this role. For predefined roles, this property shall be read-only. For custom roles, some implementations might prevent writing to this property."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070077 </Property>
78 <Property Name="OemPrivileges" Type="Collection(Edm.String)" Nullable="false">
79 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills844b4152020-06-22 12:44:09 -050080 <Annotation Term="OData.Description" String="The OEM privileges for this role."/>
81 <Annotation Term="OData.LongDescription" String="This property shall contain the OEM privileges for this role. For predefined roles, this property shall be read-only. For custom roles, some implementations might prevent writing to this property."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070082 </Property>
83 </EntityType>
Jason M. Billsea4aa752018-06-05 13:29:11 -070084 </Schema>
85
86 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_0_2">
87 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanouscb103132019-10-08 11:34:22 -070088 <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070089 <EntityType Name="Role" BaseType="Role.v1_0_0.Role"/>
90 </Schema>
91
92 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_0_3">
93 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
94 <Annotation Term="OData.Description" String="This version was created to change references to PrivilegeType to use the unversioned definition."/>
95 <EntityType Name="Role" BaseType="Role.v1_0_2.Role"/>
96 </Schema>
97
Ed Tanous530520e2019-01-02 13:41:37 -080098 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_0_4">
99 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
100 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
101 <EntityType Name="Role" BaseType="Role.v1_0_3.Role"/>
102 </Schema>
103
Ed Tanouscb103132019-10-08 11:34:22 -0700104 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_0_5">
105 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
106 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
107 <EntityType Name="Role" BaseType="Role.v1_0_4.Role"/>
108 </Schema>
109
110 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_0_6">
111 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
112 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
113 <EntityType Name="Role" BaseType="Role.v1_0_5.Role"/>
114 </Schema>
115
Gunnar Mills844b4152020-06-22 12:44:09 -0500116 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_0_7">
117 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
118 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
119 <EntityType Name="Role" BaseType="Role.v1_0_6.Role"/>
120 </Schema>
121
Jason M. Billsea4aa752018-06-05 13:29:11 -0700122 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_1_0">
123 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600124 <Annotation Term="Redfish.Release" String="2017.1"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500125
Jason M. Billsea4aa752018-06-05 13:29:11 -0700126 <EntityType Name="Role" BaseType="Role.v1_0_2.Role">
127 <Property Name="Actions" Type="Role.v1_1_0.Actions" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500128 <Annotation Term="OData.Description" String="The available actions for this resource."/>
129 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700130 </Property>
131 </EntityType>
132
133 <ComplexType Name="Actions">
134 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500135 <Annotation Term="OData.Description" String="The available actions for this resource."/>
136 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800137 <Property Name="Oem" Type="Role.v1_1_0.OemActions" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500138 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
139 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800140 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700141 </ComplexType>
142
143 <ComplexType Name="OemActions">
144 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500145 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
146 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700147 </ComplexType>
148 </Schema>
149
150 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_1_1">
151 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
152 <Annotation Term="OData.Description" String="This version was created to change references to PrivilegeType to use the unversioned definition."/>
153 <EntityType Name="Role" BaseType="Role.v1_1_0.Role"/>
154 </Schema>
155
Ed Tanous530520e2019-01-02 13:41:37 -0800156 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_1_2">
157 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
158 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
159 <EntityType Name="Role" BaseType="Role.v1_1_1.Role"/>
160 </Schema>
161
Ed Tanouscb103132019-10-08 11:34:22 -0700162 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_1_3">
163 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
164 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
165 <EntityType Name="Role" BaseType="Role.v1_1_2.Role"/>
166 </Schema>
167
168 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_1_4">
169 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
170 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
171 <EntityType Name="Role" BaseType="Role.v1_1_3.Role"/>
172 </Schema>
173
Gunnar Mills844b4152020-06-22 12:44:09 -0500174 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_1_5">
175 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
176 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
177 <EntityType Name="Role" BaseType="Role.v1_1_4.Role"/>
178 </Schema>
179
Jason M. Billsea4aa752018-06-05 13:29:11 -0700180 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_2_0">
181 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600182 <Annotation Term="Redfish.Release" String="2017.2"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500183
Jason M. Billsea4aa752018-06-05 13:29:11 -0700184 <EntityType Name="Role" BaseType="Role.v1_1_0.Role">
185 <Property Name="RoleId" Type="Edm.String" Nullable="false">
186 <Annotation Term="Redfish.RequiredOnCreate"/>
187 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500188 <Annotation Term="OData.Description" String="The name of the role."/>
189 <Annotation Term="OData.LongDescription" String="This property shall contain the string name of the role. This property shall contain the same value as the Id property."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700190 </Property>
191 </EntityType>
192 </Schema>
193
194 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_2_1">
195 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
196 <Annotation Term="OData.Description" String="This version was created to change references to PrivilegeType to use the unversioned definition."/>
197 <EntityType Name="Role" BaseType="Role.v1_2_0.Role"/>
198 </Schema>
199
Ed Tanous530520e2019-01-02 13:41:37 -0800200 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_2_2">
201 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
202 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
203 <EntityType Name="Role" BaseType="Role.v1_2_1.Role"/>
204 </Schema>
205
Ed Tanouscb103132019-10-08 11:34:22 -0700206 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_2_3">
207 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
208 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
209 <EntityType Name="Role" BaseType="Role.v1_2_2.Role"/>
210 </Schema>
211
212 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_2_4">
213 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
214 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
215 <EntityType Name="Role" BaseType="Role.v1_2_3.Role"/>
216 </Schema>
217
Gunnar Mills844b4152020-06-22 12:44:09 -0500218 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_2_5">
219 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
220 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
221 <EntityType Name="Role" BaseType="Role.v1_2_4.Role"/>
222 </Schema>
223
Gunnar Mills262d7d42021-01-20 16:28:41 -0600224 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Role.v1_3_0">
225 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
226 <Annotation Term="Redfish.Release" String="2020.4"/>
227
228 <EntityType Name="Role" BaseType="Role.v1_2_5.Role">
229 <Property Name="Restricted" Type="Edm.Boolean" Nullable="false">
230 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
231 <Annotation Term="OData.Description" String="An indication of whether use of the role is restricted."/>
232 <Annotation Term="OData.LongDescription" String="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`."/>
233 </Property>
234 <Property Name="AlternateRoleId" Type="Edm.String" Nullable="false">
235 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
236 <Annotation Term="OData.Description" String="An equivalent role to use when this role is restricted."/>
237 <Annotation Term="OData.LongDescription" String="This property shall contain a non-restricted `RoleId` intended to be used in its place when the Restricted property contains the value `true`."/>
238 </Property>
239 </EntityType>
240 </Schema>
241
Jason M. Billsea4aa752018-06-05 13:29:11 -0700242 </edmx:DataServices>
243</edmx:Edmx>