blob: cd57421fb8a440ade1da9bf84f2e007bded8c2b7 [file] [log] [blame]
Ed Tanous710adfc2017-10-24 17:04:52 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Jason M. Billsea4aa752018-06-05 13:29:11 -07004<!--# Redfish Schema: PrivilegeRegistry v1.1.1 -->
Ed Tanous710adfc2017-10-24 17:04:52 -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 -->
Jason M. Billsea4aa752018-06-05 13:29:11 -07008<!--# Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). -->
Ed Tanous710adfc2017-10-24 17:04:52 -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>
Ed Tanous710adfc2017-10-24 17:04:52 -070020 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
21 <edmx:Include Namespace="Resource.v1_0_0"/>
22 </edmx:Reference>
Jason M. Billsea4aa752018-06-05 13:29:11 -070023 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
24 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
25 </edmx:Reference>
Ed Tanous710adfc2017-10-24 17:04:52 -070026 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Privileges_v1.xml">
Jason M. Billsea4aa752018-06-05 13:29:11 -070027 <edmx:Include Namespace="Privileges"/>
Ed Tanous710adfc2017-10-24 17:04:52 -070028 </edmx:Reference>
29
30 <edmx:DataServices>
31
32 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="PrivilegeRegistry">
Jason M. Billsea4aa752018-06-05 13:29:11 -070033 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanous710adfc2017-10-24 17:04:52 -070034
35 <EntityType Name="PrivilegeRegistry" BaseType="Resource.v1_0_0.Resource" Abstract="true">
36 <Annotation Term="OData.Description" String="This is the schema definition for Operation to Privilege mapping."/>
37 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent operation to privilege mappings."/>
38 <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"/>
46 <Annotation Term="OData.Description" String="A Privilege Resource resource can be updated to change permissions on the various resource types based on a user's privilege level."/>
47 </Record>
48 </Annotation>
49 <Annotation Term="Capabilities.DeleteRestrictions">
50 <Record>
51 <PropertyValue Property="Deletable" Bool="false"/>
52 </Record>
53 </Annotation>
54 </EntityType>
55
56 </Schema>
57
58 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="PrivilegeRegistry.v1_0_0">
Jason M. Billsea4aa752018-06-05 13:29:11 -070059 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanous710adfc2017-10-24 17:04:52 -070060
61 <EntityType Name="PrivilegeRegistry" BaseType="PrivilegeRegistry.PrivilegeRegistry">
62 <Annotation Term="OData.Description" String="This is the schema definition for Operation to Privilege mapping."/>
63 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent operation to privilege mappings."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070064 <Property Name="PrivilegesUsed" Type="Collection(Privileges.PrivilegeType)" Nullable="false">
Ed Tanous710adfc2017-10-24 17:04:52 -070065 <Annotation Term="OData.Permissions" EnumMember="OData.Permissions/Read"/>
66 <Annotation Term="OData.Description" String="Lists the set of Redfish standard priviliges used in building this mapping."/>
67 </Property>
68 <Property Name="OEMPrivilegesUsed" Type="Collection(Edm.String)" Nullable="false">
69 <Annotation Term="OData.Permissions" EnumMember="OData.Permissions/Read"/>
70 <Annotation Term="OData.Description" String="Lists the set of OEM Priviliges used in building this mapping."/>
71 </Property>
72 <Property Name="Mappings" Type="Collection(PrivilegeRegistry.v1_0_0.Mapping)" Nullable="false">
73 </Property>
74 </EntityType>
75
76 <ComplexType Name="Mapping">
Jason M. Billsea4aa752018-06-05 13:29:11 -070077 <Annotation Term="OData.Description" String="This type describes a mapping between an entity and the relevant privileges used to access it."/>
78 <Annotation Term="OData.LongDescription" String="This type shall describe a mapping between an entity and the relevant privileges used to access it."/>
Ed Tanous710adfc2017-10-24 17:04:52 -070079 <Property Name="Entity" Type="Edm.String" Nullable="false">
80 <Annotation Term="OData.Permissions" EnumMember="OData.Permissions/Read"/>
81 <Annotation Term="OData.Description" String="Indicates entity name. e.g., Manager."/>
82 <Annotation Term="OData.LongDescription" String="Indicates entity name. e.g., Manager."/>
83 </Property>
84 <Property Name="SubordinateOverrides" Type="Collection(PrivilegeRegistry.v1_0_0.Target_PrivilegeMap)" Nullable="true">
85 <Annotation Term="OData.Description" String="Indicates privilege overrides of subordinate resource."/>
86 <Annotation Term="OData.LongDescription" String="Indicates privilege overrides of subordinate resource. Target lists referenced by Entity."/>
87 </Property>
88 <Property Name="ResourceURIOverrides" Type="Collection(PrivilegeRegistry.v1_0_0.Target_PrivilegeMap)" Nullable="true">
89 <Annotation Term="OData.Description" String="Indicates privilege overrides of Resource URI."/>
90 <Annotation Term="OData.LongDescription" String="Indicates privilege overrides of Resource URI. Target lists Resource URI."/>
91 </Property>
92 <Property Name="PropertyOverrides" Type="Collection(PrivilegeRegistry.v1_0_0.Target_PrivilegeMap)" Nullable="true">
93 <Annotation Term="OData.Description" String="Indicates privilege overrides of property or element within a entity."/>
94 <Annotation Term="OData.LongDescription" String="Indicates privilege overrides of property or element. e.g., password property."/>
95 </Property>
96 <Property Name="OperationMap" Type="PrivilegeRegistry.v1_0_0.OperationMap" Nullable="false">
97 <Annotation Term="OData.Description" String="List mapping between HTTP method and privilege required for entity."/>
98 <Annotation Term="OData.LongDescription" String="List mapping between HTTP method and privilege required for entity."/>
99 </Property>
100 </ComplexType>
101
102 <ComplexType Name="Target_PrivilegeMap">
Jason M. Billsea4aa752018-06-05 13:29:11 -0700103 <Annotation Term="OData.Description" String="This type describes a mapping between one or more targets and the HTTP operations associated with them."/>
104 <Annotation Term="OData.LongDescription" String="This type shall describe a mapping between one or more targets and the HTTP operations associated with them."/>
Ed Tanous710adfc2017-10-24 17:04:52 -0700105 <Property Name="Targets" Type="Collection(Edm.String)" Nullable="true">
106 <Annotation Term="OData.Permissions" EnumMember="OData.Permissions/Read"/>
107 <Annotation Term="OData.Description" String="Indicates the URI or Entity."/>
108 <Annotation Term="OData.LongDescription" String="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."/>
109 </Property>
110 <Property Name="OperationMap" Type="PrivilegeRegistry.v1_0_0.OperationMap" >
111 <Annotation Term="OData.Description" String="List mapping between HTTP operation and privilege needed to perform operation."/>
112 <Annotation Term="OData.LongDescription" String="List mapping between HTTP operation and privilege needed to perform operation."/>
113 </Property>
114 </ComplexType>
115
116 <ComplexType Name="OperationMap">
117 <Annotation Term="OData.Description" String="Used for describing the specific privileges for a set of HTTP operations."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700118 <Annotation Term="OData.LongDescription" String="This type shall describe the specific privileges required for a set of HTTP operations."/>
Ed Tanous710adfc2017-10-24 17:04:52 -0700119 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
120 <Property Name="GET" Type="Collection(PrivilegeRegistry.v1_0_0.OperationPrivilege)" Nullable="false">
121 <Annotation Term="OData.Description" String="Indicates privilege required for HTTP GET operation."/>
122 <Annotation Term="OData.LongDescription" String="Indicates privilege required for HTTP GET operation."/>
123 </Property>
124 <Property Name="HEAD" Type="Collection(PrivilegeRegistry.v1_0_0.OperationPrivilege)" Nullable="false">
125 <Annotation Term="OData.Description" String="Indicates privilege required for HTTP HEAD operation."/>
126 <Annotation Term="OData.LongDescription" String="Indicates privilege required for HTTP HEAD operation."/>
127 </Property>
128 <Property Name="PATCH" Type="Collection(PrivilegeRegistry.v1_0_0.OperationPrivilege)" Nullable="false">
129 <Annotation Term="OData.Description" String="Indicates privilege required for HTTP PATCH operation."/>
130 <Annotation Term="OData.LongDescription" String="Indicates privilege required for HTTP PATCH operation."/>
131 </Property>
132 <Property Name="POST" Type="Collection(PrivilegeRegistry.v1_0_0.OperationPrivilege)" Nullable="false">
133 <Annotation Term="OData.Description" String="Indicates privilege required for HTTP POST operation."/>
134 <Annotation Term="OData.LongDescription" String="Indicates privilege required for HTTP POST operation."/>
135 </Property>
136 <Property Name="PUT" Type="Collection(PrivilegeRegistry.v1_0_0.OperationPrivilege)" Nullable="false">
137 <Annotation Term="OData.Description" String="Indicates privilege required for HTTP PUT operation."/>
138 <Annotation Term="OData.LongDescription" String="Indicates privilege required for HTTP PUT operation."/>
139 </Property>
140 <Property Name="DELETE" Type="Collection(PrivilegeRegistry.v1_0_0.OperationPrivilege)" Nullable="false">
141 <Annotation Term="OData.Description" String="Indicates privilege required for HTTP DELETE operation."/>
142 <Annotation Term="OData.LongDescription" String="Indicates privilege required for HTTP DELETE operation."/>
143 </Property>
144 </ComplexType>
145
146 <ComplexType Name="OperationPrivilege">
147 <Annotation Term="OData.Description" String="Used for describing the specific privileges for a given type of HTTP operation."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700148 <Annotation Term="OData.LongDescription" String="This type shall describe the specific privileges required for a given type of HTTP operation."/>
Ed Tanous710adfc2017-10-24 17:04:52 -0700149 <Property Name="Privilege" Type="Collection(Edm.String)" Nullable="false">
150 <Annotation Term="OData.Permissions" EnumMember="OData.Permissions/Read"/>
151 <Annotation Term="OData.Description" String="Lists the privileges that are allowed to perform the given type of HTTP operation on the entity type."/>
152 <Annotation Term="OData.LongDescription" String="This array shall contain a set of strings that match 0 or more of the strings found in the PrivilegesUsed and OEMPrivilegesUsed properties."/>
153 </Property>
154 </ComplexType>
155
156 </Schema>
157
Jason M. Billsea4aa752018-06-05 13:29:11 -0700158 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="PrivilegeRegistry.v1_0_1">
159 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
160 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
161 <EntityType Name="PrivilegeRegistry" BaseType="PrivilegeRegistry.v1_0_0.PrivilegeRegistry"/>
162 </Schema>
163
164 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="PrivilegeRegistry.v1_0_2">
165 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
166 <Annotation Term="OData.Description" String="This version was created to change references to PrivilegeType to use the unversioned definition."/>
167 <EntityType Name="PrivilegeRegistry" BaseType="PrivilegeRegistry.v1_0_1.PrivilegeRegistry"/>
168 </Schema>
169
170 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="PrivilegeRegistry.v1_1_0">
171 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
172 <EntityType Name="PrivilegeRegistry" BaseType="PrivilegeRegistry.v1_0_1.PrivilegeRegistry">
173 <Property Name="Actions" Type="PrivilegeRegistry.v1_1_0.Actions" Nullable="false">
174 <Annotation Term="OData.Description" String="The available actions for this resource."/>
175 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
176 </Property>
177 </EntityType>
178
179 <ComplexType Name="Actions">
180 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
181 <Annotation Term="OData.Description" String="The available actions for this resource."/>
182 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
183 <Property Name="Oem" Type="PrivilegeRegistry.v1_1_0.OemActions" Nullable="false"/>
184 </ComplexType>
185
186 <ComplexType Name="OemActions">
187 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
188 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
189 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
190 </ComplexType>
191 </Schema>
192
193 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="PrivilegeRegistry.v1_1_1">
194 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
195 <Annotation Term="OData.Description" String="This version was created to change references to PrivilegeType to use the unversioned definition."/>
196 <EntityType Name="PrivilegeRegistry" BaseType="PrivilegeRegistry.v1_1_0.PrivilegeRegistry"/>
197 </Schema>
198
Ed Tanous710adfc2017-10-24 17:04:52 -0700199 </edmx:DataServices>
200</edmx:Edmx>