blob: e2dd2e0b58248c0026290a5d4923197bcb7693de [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Ed Tanousa8d8f9d2023-01-26 13:57:00 -08004<!--# Redfish Schema: AccountService v1.12.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 -->
Ed Tanoused761212022-09-23 15:03:29 -07008<!--# Copyright 2014-2022 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.Measures.V1.xml">
18 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
21 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
24 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
25 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
28 <edmx:Include Namespace="Resource"/>
29 <edmx:Include Namespace="Resource.v1_0_0"/>
30 </edmx:Reference>
31 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ManagerAccountCollection_v1.xml">
32 <edmx:Include Namespace="ManagerAccountCollection"/>
33 </edmx:Reference>
34 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RoleCollection_v1.xml">
35 <edmx:Include Namespace="RoleCollection"/>
36 </edmx:Reference>
37 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/PrivilegeRegistry_v1.xml">
38 <edmx:Include Namespace="PrivilegeRegistry"/>
39 </edmx:Reference>
40 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ExternalAccountProviderCollection_v1.xml">
41 <edmx:Include Namespace="ExternalAccountProviderCollection"/>
42 </edmx:Reference>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060043 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/CertificateCollection_v1.xml">
44 <edmx:Include Namespace="CertificateCollection"/>
45 </edmx:Reference>
Gunnar Mills262d7d42021-01-20 16:28:41 -060046 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Privileges_v1.xml">
47 <edmx:Include Namespace="Privileges"/>
48 </edmx:Reference>
49 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ManagerAccount_v1.xml">
50 <edmx:Include Namespace="ManagerAccount"/>
51 </edmx:Reference>
Jason M. Billsea4aa752018-06-05 13:29:11 -070052
53 <edmx:DataServices>
54
55 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService">
56 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
57
58 <EntityType Name="AccountService" BaseType="Resource.v1_0_0.Resource" Abstract="true">
Gunnar Mills9d424662021-09-22 21:56:16 -050059 <Annotation Term="OData.Description" String="The AccountService schema defines an account service. The properties are common to, and enable management of, all user accounts. The properties include the password requirements and control features, such as account lockout. Properties and actions in this service specify general behavior that should be followed for typical accounts, however implementations may override these behaviors for special accounts or situations to avoid denial of service or other deadlock situations."/>
60 <Annotation Term="OData.LongDescription" String="This resource shall represent an account service for a Redfish implementation. The properties are common to, and enable management of, all user accounts. The properties include the password requirements and control features, such as account lockout. Properties and actions in this service specify general behavior that should be followed for typical accounts, however implementations may override these behaviors for special accounts or situations to avoid denial of service or other deadlock situations."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070061 <Annotation Term="Capabilities.InsertRestrictions">
62 <Record>
63 <PropertyValue Property="Insertable" Bool="false"/>
64 </Record>
65 </Annotation>
66 <Annotation Term="Capabilities.UpdateRestrictions">
67 <Record>
68 <PropertyValue Property="Updatable" Bool="true"/>
Gunnar Mills844b4152020-06-22 12:44:09 -050069 <Annotation Term="OData.Description" String="Some properties, such as thresholds and durations, can be updated for the account service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070070 </Record>
71 </Annotation>
72 <Annotation Term="Capabilities.DeleteRestrictions">
73 <Record>
74 <PropertyValue Property="Deletable" Bool="false"/>
75 </Record>
76 </Annotation>
Ed Tanous530520e2019-01-02 13:41:37 -080077 <Annotation Term="Redfish.Uris">
78 <Collection>
79 <String>/redfish/v1/AccountService</String>
80 <String>/redfish/v1/Managers/{ManagerId}/RemoteAccountService</String>
81 </Collection>
82 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -070083 </EntityType>
Ed Tanousa8d8f9d2023-01-26 13:57:00 -080084
85 <ComplexType Name="MFABypass" Abstract="true">
86 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
87 <Annotation Term="OData.Description" String="Multi-factor authentication bypass settings."/>
88 <Annotation Term="OData.LongDescription" String="This type shall contain multi-factor authentication bypass settings."/>
89 </ComplexType>
90
91 <EnumType Name="MFABypassType">
92 <Annotation Term="Redfish.Revisions">
93 <Collection>
94 <Record>
95 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
96 <PropertyValue Property="Version" String="v1_12_0"/>
97 </Record>
98 </Collection>
99 </Annotation>
100 <Member Name="All">
101 <Annotation Term="OData.Description" String="Bypass all multi-factor authentication types."/>
102 <Annotation Term="OData.LongDescription" String="This value shall indicate an account or role mapping can bypass all multi-factor authentication types including OEM-defined types."/>
103 </Member>
104 <Member Name="SecurID">
105 <Annotation Term="OData.Description" String="Bypass RSA SecurID."/>
106 <Annotation Term="OData.LongDescription" String="This value shall indicate an account or role mapping can bypass RSA SecurID."/>
107 </Member>
108 <Member Name="GoogleAuthenticator">
109 <Annotation Term="OData.Description" String="Bypass Google Authenticator."/>
110 <Annotation Term="OData.LongDescription" String="This value shall indicate an account or role mapping can bypass Google Authenticator."/>
111 </Member>
112 <Member Name="MicrosoftAuthenticator">
113 <Annotation Term="OData.Description" String="Bypass Microsoft Authenticator."/>
114 <Annotation Term="OData.LongDescription" String="This value shall indicate an account or role mapping can bypass Microsoft Authenticator."/>
115 </Member>
116 <Member Name="ClientCertificate">
117 <Annotation Term="OData.Description" String="Bypass client certificate authentication."/>
118 <Annotation Term="OData.LongDescription" String="This value shall indicate an account or role mapping can bypass client certificate authentication."/>
119 </Member>
120 <Member Name="OEM">
121 <Annotation Term="OData.Description" String="Bypass OEM-defined multi-factor authentication."/>
122 <Annotation Term="OData.LongDescription" String="This value shall indicate an account or role mapping can bypass OEM-defined multi-factor authentication."/>
123 </Member>
124 </EnumType>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700125 </Schema>
126
127 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_0">
128 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600129 <Annotation Term="Redfish.Release" String="1.0"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700130
131 <EntityType Name="AccountService" BaseType="AccountService.AccountService">
Ed Tanous530520e2019-01-02 13:41:37 -0800132 <Property Name="Status" Type="Resource.Status" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500133 <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
134 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800135 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700136 <Property Name="ServiceEnabled" Type="Edm.Boolean">
137 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500138 <Annotation Term="OData.Description" String="An indication of whether the account service is enabled. If `true`, it is enabled. If `false`, it is disabled and users cannot be created, deleted, or modified, and new sessions cannot be started. However, established sessions might still continue to run. Any service, such as the session service, that attempts to access the disabled account service fails. However, this does not affect HTTP Basic Authentication connections."/>
Gunnar Mills10f270b2021-05-19 15:34:06 -0500139 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the account service is enabled. If `true`, it is enabled. If `false`, it is disabled and users cannot be created, deleted, or modified, and new sessions cannot be started. However, established sessions may still continue to run. Any service, such as the session service, that attempts to access the disabled account service fails. However, this does not affect HTTP Basic Authentication connections."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700140 </Property>
141 <Property Name="AuthFailureLoggingThreshold" Type="Edm.Int64" Nullable="false">
142 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500143 <Annotation Term="OData.Description" String="The number of authorization failures per account that are allowed before the failed attempt is logged to the manager log."/>
144 <Annotation Term="OData.LongDescription" String="This property shall contain the threshold for when an authorization failure is logged. Logging shall occur after every `n` occurrences of an authorization failure on the same account, where `n` represents the value of this property. If the value is `0`, logging of authorization failures shall be disabled."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700145 <Annotation Term="Validation.Minimum" Int="0"/>
146 </Property>
147 <Property Name="MinPasswordLength" Type="Edm.Int64" Nullable="false">
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500148 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500149 <Annotation Term="OData.Description" String="The minimum password length for this account service."/>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500150 <Annotation Term="OData.LongDescription" String="This property shall contain the minimum password length that the implementation allows for this account service. This property does not apply to accounts from external account providers."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700151 <Annotation Term="Validation.Minimum" Int="0"/>
152 </Property>
153 <Property Name="MaxPasswordLength" Type="Edm.Int64" Nullable="false">
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500154 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500155 <Annotation Term="OData.Description" String="The maximum password length for this account service."/>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500156 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum password length that the implementation allows for this account service. This property does not apply to accounts from external account providers."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700157 <Annotation Term="Validation.Minimum" Int="0"/>
158 </Property>
159 <Property Name="AccountLockoutThreshold" Type="Edm.Int64" Nullable="true">
160 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700161 <Annotation Term="OData.Description" String="The number of allowed failed login attempts before a user account is locked for a specified duration. If `0`, the account is never locked."/>
162 <Annotation Term="OData.LongDescription" String="This property shall contain the threshold of failed login attempts before a user account is locked. If `0`, the account shall never be locked."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700163 <Annotation Term="Validation.Minimum" Int="0"/>
164 </Property>
165 <Property Name="AccountLockoutDuration" Type="Edm.Int64" Nullable="true">
166 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700167 <Annotation Term="OData.Description" String="The period of time, in seconds, that an account is locked after the number of failed login attempts reaches the account lockout threshold, within the period between the last failed login attempt and the reset of the lockout threshold counter. If this value is `0`, no lockout will occur. If the AccountLockoutCounterResetEnabled value is `false`, this property is ignored."/>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600168 <Annotation Term="OData.LongDescription" String="This property shall contain the period of time, in seconds, that an account is locked after the number of failed login attempts reaches the AccountLockoutThreshold value, within the AccountLockoutCounterResetAfter window of time. The value shall be greater than or equal to the AccountLockoutCounterResetAfter value. If this value is `0`, no lockout shall occur. If AccountLockoutCounterResetEnabled value is `false`, this property shall be ignored."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700169 <Annotation Term="Validation.Minimum" Int="0"/>
170 <Annotation Term="Measures.Unit" String="s"/>
171 </Property>
172 <Property Name="AccountLockoutCounterResetAfter" Type="Edm.Int64" Nullable="false">
173 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700174 <Annotation Term="OData.Description" String="The period of time, in seconds, between the last failed login attempt and the reset of the lockout threshold counter. This value must be less than or equal to the AccountLockoutDuration value. A reset sets the counter to `0`."/>
175 <Annotation Term="OData.LongDescription" String="This property shall contain the period of time, in seconds, from the last failed login attempt when the AccountLockoutThreshold counter, which counts the number of failed login attempts, is reset to `0`. Then, AccountLockoutThreshold failures are required before the account is locked. This value shall be less than or equal to the AccountLockoutDuration value. The threshold counter also resets to `0` after each successful login. If the AccountLockoutCounterResetEnabled value is `false`, this property shall be ignored."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700176 <Annotation Term="Validation.Minimum" Int="0"/>
177 <Annotation Term="Measures.Unit" String="s"/>
178 </Property>
179 <NavigationProperty Name="Accounts" Type="ManagerAccountCollection.ManagerAccountCollection" ContainsTarget="true" Nullable="false">
180 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700181 <Annotation Term="OData.Description" String="The collection of manager accounts."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500182 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type ManagerAccountCollection."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700183 <Annotation Term="OData.AutoExpandReferences"/>
184 </NavigationProperty>
185 <NavigationProperty Name="Roles" Type="RoleCollection.RoleCollection" ContainsTarget="true" Nullable="false">
186 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500187 <Annotation Term="OData.Description" String="The collection of Redfish roles."/>
188 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type RoleCollection."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700189 <Annotation Term="OData.AutoExpandReferences"/>
190 </NavigationProperty>
191 </EntityType>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700192 </Schema>
193
194 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_2">
195 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700196 <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 -0700197 <EntityType Name="AccountService" BaseType="AccountService.v1_0_0.AccountService"/>
198 </Schema>
199
200 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_3">
201 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500202 <Annotation Term="OData.Description" String="This version was created to add explicit permissions annotations to all properties for clarity."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700203 <EntityType Name="AccountService" BaseType="AccountService.v1_0_2.AccountService"/>
204 </Schema>
205
206 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_4">
207 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
208 <Annotation Term="OData.Description" String="This version was created to fix supported types."/>
209 <EntityType Name="AccountService" BaseType="AccountService.v1_0_3.AccountService"/>
210 </Schema>
211
212 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_5">
213 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700214 <Annotation Term="OData.Description" String="This version was created to fix supported types, which are the ServiceEnabled fixed and long descriptions."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700215 <EntityType Name="AccountService" BaseType="AccountService.v1_0_4.AccountService"/>
216 </Schema>
217
Ed Tanous530520e2019-01-02 13:41:37 -0800218 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_6">
219 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
220 <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."/>
221 <EntityType Name="AccountService" BaseType="AccountService.v1_0_5.AccountService"/>
222 </Schema>
223
Ed Tanouscb103132019-10-08 11:34:22 -0700224 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_7">
225 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
226 <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."/>
227 <EntityType Name="AccountService" BaseType="AccountService.v1_0_6.AccountService"/>
228 </Schema>
229
230 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_8">
231 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
232 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
233 <EntityType Name="AccountService" BaseType="AccountService.v1_0_7.AccountService"/>
234 </Schema>
235
Gunnar Mills844b4152020-06-22 12:44:09 -0500236 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_9">
237 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
238 <Annotation Term="OData.Description" String="This version was created to clarify the description for AuthFailureLoggingThreshold."/>
239 <EntityType Name="AccountService" BaseType="AccountService.v1_0_8.AccountService"/>
240 </Schema>
241
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500242 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_10">
243 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
244 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions for MinPasswordLength and MaxPasswordLength to state they do not apply to accounts from external account providers. It was also updated to make MinPasswordLength and MaxPasswordLength writable. The description for AuthFailureLoggingThreshold was also updated to clarify that the threshold applies to authentication failures per account."/>
245 <EntityType Name="AccountService" BaseType="AccountService.v1_0_9.AccountService"/>
246 </Schema>
247
Gunnar Mills262d7d42021-01-20 16:28:41 -0600248 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_11">
249 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
250 <Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
251 <EntityType Name="AccountService" BaseType="AccountService.v1_0_10.AccountService"/>
252 </Schema>
253
Gunnar Mills10f270b2021-05-19 15:34:06 -0500254 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_12">
255 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
256 <Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
257 <EntityType Name="AccountService" BaseType="AccountService.v1_0_11.AccountService"/>
258 </Schema>
259
Gunnar Mills9d424662021-09-22 21:56:16 -0500260 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_0_13">
261 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
262 <Annotation Term="OData.Description" String="This version was created to clarify that services are allowed to protect accounts to avoid deadlock conditions."/>
263 <EntityType Name="AccountService" BaseType="AccountService.v1_0_12.AccountService"/>
264 </Schema>
265
Jason M. Billsea4aa752018-06-05 13:29:11 -0700266 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_1_0">
267 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600268 <Annotation Term="Redfish.Release" String="2016.3"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500269
Jason M. Billsea4aa752018-06-05 13:29:11 -0700270 <EntityType Name="AccountService" BaseType="AccountService.v1_0_3.AccountService">
271 <NavigationProperty Name="PrivilegeMap" Type="PrivilegeRegistry.PrivilegeRegistry" ContainsTarget="true" Nullable="false">
272 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500273 <Annotation Term="OData.Description" String="The link to the mapping of the privileges required to complete a requested operation on a URI associated with this service."/>
274 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type PrivilegeMapping that contains the privileges that are required for a user context to complete a requested operation on a URI associated with this service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700275 <Annotation Term="OData.AutoExpandReferences"/>
276 </NavigationProperty>
277 </EntityType>
278 </Schema>
279
280 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_1_1">
281 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
282 <Annotation Term="OData.Description" String="This version was created to fix supported types."/>
283 <EntityType Name="AccountService" BaseType="AccountService.v1_1_0.AccountService"/>
284 </Schema>
285
286 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_1_2">
287 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700288 <Annotation Term="OData.Description" String="This version was created to fix the description for ServiceEnabled."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700289 <EntityType Name="AccountService" BaseType="AccountService.v1_1_1.AccountService"/>
290 </Schema>
291
Ed Tanous530520e2019-01-02 13:41:37 -0800292 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_1_3">
293 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
294 <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."/>
295 <EntityType Name="AccountService" BaseType="AccountService.v1_1_2.AccountService"/>
296 </Schema>
297
Ed Tanouscb103132019-10-08 11:34:22 -0700298 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_1_4">
299 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
300 <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."/>
301 <EntityType Name="AccountService" BaseType="AccountService.v1_1_3.AccountService"/>
302 </Schema>
303
304 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_1_5">
305 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
306 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
307 <EntityType Name="AccountService" BaseType="AccountService.v1_1_4.AccountService"/>
308 </Schema>
309
Gunnar Mills844b4152020-06-22 12:44:09 -0500310 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_1_6">
311 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
312 <Annotation Term="OData.Description" String="This version was created to clarify the description for AuthFailureLoggingThreshold."/>
313 <EntityType Name="AccountService" BaseType="AccountService.v1_1_5.AccountService"/>
314 </Schema>
315
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500316 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_1_7">
317 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
318 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions for MinPasswordLength and MaxPasswordLength to state they do not apply to accounts from external account providers. It was also updated to make MinPasswordLength and MaxPasswordLength writable. The description for AuthFailureLoggingThreshold was also updated to clarify that the threshold applies to authentication failures per account."/>
319 <EntityType Name="AccountService" BaseType="AccountService.v1_1_6.AccountService"/>
320 </Schema>
321
Gunnar Mills262d7d42021-01-20 16:28:41 -0600322 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_1_8">
323 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
324 <Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
325 <EntityType Name="AccountService" BaseType="AccountService.v1_1_7.AccountService"/>
326 </Schema>
327
Gunnar Mills10f270b2021-05-19 15:34:06 -0500328 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_1_9">
329 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
330 <Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
331 <EntityType Name="AccountService" BaseType="AccountService.v1_1_8.AccountService"/>
332 </Schema>
333
Gunnar Mills9d424662021-09-22 21:56:16 -0500334 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_1_10">
335 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
336 <Annotation Term="OData.Description" String="This version was created to clarify that services are allowed to protect accounts to avoid deadlock conditions."/>
337 <EntityType Name="AccountService" BaseType="AccountService.v1_1_9.AccountService"/>
338 </Schema>
339
Jason M. Billsea4aa752018-06-05 13:29:11 -0700340 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_2_0">
341 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600342 <Annotation Term="Redfish.Release" String="2017.1"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500343
Jason M. Billsea4aa752018-06-05 13:29:11 -0700344 <EntityType Name="AccountService" BaseType="AccountService.v1_1_1.AccountService">
345 <Property Name="Actions" Type="AccountService.v1_2_0.Actions" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500346 <Annotation Term="OData.Description" String="The available actions for this resource."/>
347 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700348 </Property>
349 </EntityType>
350
351 <ComplexType Name="Actions">
352 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500353 <Annotation Term="OData.Description" String="The available actions for this resource."/>
354 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800355 <Property Name="Oem" Type="AccountService.v1_2_0.OemActions" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500356 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
357 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800358 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700359 </ComplexType>
360
361 <ComplexType Name="OemActions">
362 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500363 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
364 <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 -0700365 </ComplexType>
366 </Schema>
367
368 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_2_1">
369 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700370 <Annotation Term="OData.Description" String="This version was created to fix the description for ServiceEnabled."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700371 <EntityType Name="AccountService" BaseType="AccountService.v1_2_0.AccountService"/>
372 </Schema>
373
374 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_2_2">
375 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700376 <Annotation Term="OData.Description" String="This version was created to update the descriptions in this schema."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700377 <EntityType Name="AccountService" BaseType="AccountService.v1_2_1.AccountService"/>
378 </Schema>
379
Ed Tanous530520e2019-01-02 13:41:37 -0800380 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_2_3">
381 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
382 <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."/>
383 <EntityType Name="AccountService" BaseType="AccountService.v1_2_2.AccountService"/>
384 </Schema>
385
Ed Tanouscb103132019-10-08 11:34:22 -0700386 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_2_4">
387 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
388 <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."/>
389 <EntityType Name="AccountService" BaseType="AccountService.v1_2_3.AccountService"/>
390 </Schema>
391
392 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_2_5">
393 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
394 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
395 <EntityType Name="AccountService" BaseType="AccountService.v1_2_4.AccountService"/>
396 </Schema>
397
Gunnar Mills844b4152020-06-22 12:44:09 -0500398 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_2_6">
399 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
400 <Annotation Term="OData.Description" String="This version was created to clarify the description for AuthFailureLoggingThreshold."/>
401 <EntityType Name="AccountService" BaseType="AccountService.v1_2_5.AccountService"/>
402 </Schema>
403
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500404 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_2_7">
405 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
406 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions for MinPasswordLength and MaxPasswordLength to state they do not apply to accounts from external account providers. It was also updated to make MinPasswordLength and MaxPasswordLength writable. The description for AuthFailureLoggingThreshold was also updated to clarify that the threshold applies to authentication failures per account."/>
407 <EntityType Name="AccountService" BaseType="AccountService.v1_2_6.AccountService"/>
408 </Schema>
409
Gunnar Mills262d7d42021-01-20 16:28:41 -0600410 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_2_8">
411 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
412 <Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
413 <EntityType Name="AccountService" BaseType="AccountService.v1_2_7.AccountService"/>
414 </Schema>
415
Gunnar Mills10f270b2021-05-19 15:34:06 -0500416 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_2_9">
417 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
418 <Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
419 <EntityType Name="AccountService" BaseType="AccountService.v1_2_8.AccountService"/>
420 </Schema>
421
Gunnar Mills9d424662021-09-22 21:56:16 -0500422 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_2_10">
423 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
424 <Annotation Term="OData.Description" String="This version was created to clarify that services are allowed to protect accounts to avoid deadlock conditions."/>
425 <EntityType Name="AccountService" BaseType="AccountService.v1_2_9.AccountService"/>
426 </Schema>
427
Jason M. Billsea4aa752018-06-05 13:29:11 -0700428 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_3_0">
429 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600430 <Annotation Term="Redfish.Release" String="2018.1"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700431
432 <EntityType Name="AccountService" BaseType="AccountService.v1_2_2.AccountService">
433 <Property Name="LocalAccountAuth" Type="AccountService.v1_3_0.LocalAccountAuth" Nullable="false">
434 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500435 <Annotation Term="OData.Description" String="An indication of how the service uses the accounts collection within this account service as part of authentication. The enumerated values describe the details for each mode."/>
436 <Annotation Term="OData.LongDescription" String="This property shall govern how the service uses the manager accounts resource collection within this account service as part of authentication. The enumerated values describe the details for each mode."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700437 </Property>
438 <Property Name="LDAP" Type="AccountService.v1_3_0.ExternalAccountProvider" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500439 <Annotation Term="OData.Description" String="The first LDAP external account provider that this account service supports."/>
440 <Annotation Term="OData.LongDescription" String="This property shall contain the first LDAP external account provider that this account service supports. If the account service supports one or more LDAP services as an external account provider, this entity shall be populated by default. This entity shall not be present in the additional external account providers resource collection."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700441 </Property>
442 <Property Name="ActiveDirectory" Type="AccountService.v1_3_0.ExternalAccountProvider" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500443 <Annotation Term="OData.Description" String="The first Active Directory external account provider that this account service supports."/>
444 <Annotation Term="OData.LongDescription" String="This property shall contain the first Active Directory external account provider that this account service supports. If the account service supports one or more Active Directory services as an external account provider, this entity shall be populated by default. This entity shall not be present in the additional external account providers resource collection."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700445 </Property>
446 <NavigationProperty Name="AdditionalExternalAccountProviders" Type="ExternalAccountProviderCollection.ExternalAccountProviderCollection" ContainsTarget="true" Nullable="false">
447 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500448 <Annotation Term="OData.Description" String="The additional external account providers that this account service uses."/>
449 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type ExternalAccountProviderCollection that represents the additional external account providers that this account service uses."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700450 </NavigationProperty>
451 </EntityType>
452
453 <EnumType Name="LocalAccountAuth">
454 <Member Name="Enabled">
Gunnar Mills844b4152020-06-22 12:44:09 -0500455 <Annotation Term="OData.Description" String="The service authenticates users based on the account service-defined accounts collection."/>
456 <Annotation Term="OData.LongDescription" String="The service shall authenticate users based on the account service-defined manager accounts resource collection."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700457 </Member>
458 <Member Name="Disabled">
Gunnar Mills844b4152020-06-22 12:44:09 -0500459 <Annotation Term="OData.Description" String="The service never authenticates users based on the account service-defined accounts collection."/>
460 <Annotation Term="OData.LongDescription" String="The service shall never authenticate users based on the account service-defined manager accounts resource collection."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700461 </Member>
462 <Member Name="Fallback">
Gunnar Mills844b4152020-06-22 12:44:09 -0500463 <Annotation Term="OData.Description" String="The service authenticates users based on the account service-defined accounts collection only if any external account providers are currently unreachable."/>
464 <Annotation Term="OData.LongDescription" String="The service shall authenticate users based on the account service-defined manager accounts resource collection only if any external account providers are currently unreachable."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700465 </Member>
466 <Member Name="LocalFirst">
Gunnar Mills844b4152020-06-22 12:44:09 -0500467 <Annotation Term="OData.Description" String="The service first authenticates users based on the account service-defined accounts collection. If authentication fails, the service authenticates by using external account providers."/>
468 <Annotation Term="OData.LongDescription" String="The service shall first authenticate users based on the account service-defined manager accounts resource collection. If authentication fails, the service shall authenticate by using external account providers."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700469 <Annotation Term="Redfish.Revisions">
470 <Collection>
471 <Record>
472 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
473 <PropertyValue Property="Version" String="v1_6_0"/>
474 </Record>
475 </Collection>
476 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700477 </Member>
478 </EnumType>
479
480 <ComplexType Name="ExternalAccountProvider">
Ed Tanouscb103132019-10-08 11:34:22 -0700481 <Annotation Term="OData.Description" String="The external account provider services that can provide accounts for this manager to use for authentication."/>
482 <Annotation Term="OData.LongDescription" String="This type shall contain properties that represent external account provider services that can provide accounts for this manager to use for authentication."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700483 <Property Name="AccountProviderType" Type="AccountService.v1_3_0.AccountProviderTypes">
484 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500485 <Annotation Term="OData.Description" String="The type of external account provider to which this service connects."/>
486 <Annotation Term="OData.LongDescription" String="This property shall contain the type of external account provider to which this service connects."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700487 <Annotation Term="Redfish.Revisions">
488 <Collection>
489 <Record>
490 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/>
491 <PropertyValue Property="Version" String="v1_5_0"/>
492 <PropertyValue Property="Description" String="This property is deprecated because the account provider type is known when used in the LDAP and ActiveDirectory objects."/>
493 </Record>
494 </Collection>
495 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700496 </Property>
497 <Property Name="ServiceEnabled" Type="Edm.Boolean">
498 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700499 <Annotation Term="OData.Description" String="An indication of whether this service is enabled."/>
500 <Annotation Term="OData.LongDescription" String="This property shall indicate whether this service is enabled."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700501 </Property>
502 <Property Name="ServiceAddresses" Type="Collection(Edm.String)">
503 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700504 <Annotation Term="OData.Description" String="The addresses of the user account providers to which this external account provider links. The format of this field depends on the type of external account provider."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500505 <Annotation Term="OData.LongDescription" String="This property shall contain the addresses of the account providers to which this external account provider links. The format of this field depends on the type of external account provider. Each item in the array shall contain a single address. Services can define their own behavior for managing multiple addresses."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700506 </Property>
Ed Tanouscb103132019-10-08 11:34:22 -0700507 <Property Name="Authentication" Type="AccountService.v1_3_0.Authentication" Nullable="false">
508 <Annotation Term="OData.Description" String="The authentication information for the external account provider."/>
509 <Annotation Term="OData.LongDescription" String="This property shall contain the authentication information for the external account provider."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700510 </Property>
Ed Tanouscb103132019-10-08 11:34:22 -0700511 <Property Name="LDAPService" Type="AccountService.v1_3_0.LDAPService" Nullable="false">
512 <Annotation Term="OData.Description" String="The additional mapping information needed to parse a generic LDAP service."/>
513 <Annotation Term="OData.LongDescription" String="This property shall contain any additional mapping information needed to parse a generic LDAP service. This property should only be present inside the LDAP property."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700514 </Property>
515 <Property Name="RemoteRoleMapping" Type="Collection(AccountService.v1_3_0.RoleMapping)">
Gunnar Mills844b4152020-06-22 12:44:09 -0500516 <Annotation Term="OData.Description" String="The mapping rules to convert the external account providers account information to the local Redfish role."/>
517 <Annotation Term="OData.LongDescription" String="This property shall contain a set of the mapping rules that are used to convert the external account providers account information to the local Redfish role."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700518 </Property>
519 </ComplexType>
520
521 <EnumType Name="AccountProviderTypes">
522 <Member Name="RedfishService">
Gunnar Mills844b4152020-06-22 12:44:09 -0500523 <Annotation Term="OData.Description" String="An external Redfish service."/>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600524 <Annotation Term="OData.LongDescription" String="The external account provider shall be a DMTF Redfish Specification-conformant service. The ServiceAddresses format shall contain a set of URIs that correspond to a Redfish account service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700525 </Member>
526 <Member Name="ActiveDirectoryService">
Ed Tanouscb103132019-10-08 11:34:22 -0700527 <Annotation Term="OData.Description" String="An external Active Directory service."/>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600528 <Annotation Term="OData.LongDescription" String="The external account provider shall be a Microsoft Active Directory Technical Specification-conformant service. The ServiceAddresses format shall contain a set of fully qualified domain names (FQDN) or NetBIOS names that links to the set of domain servers for the Active Directory service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700529 </Member>
530 <Member Name="LDAPService">
Ed Tanouscb103132019-10-08 11:34:22 -0700531 <Annotation Term="OData.Description" String="A generic external LDAP service."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500532 <Annotation Term="OData.LongDescription" String="The external account provider shall be an RFC4511-conformant service. The ServiceAddresses format shall contain a set of fully qualified domain names (FQDN) that links to the set of LDAP servers for the service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700533 </Member>
534 <Member Name="OEM">
Ed Tanouscb103132019-10-08 11:34:22 -0700535 <Annotation Term="OData.Description" String="An OEM-specific external authentication or directory service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700536 </Member>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600537 <Member Name="TACACSplus">
538 <Annotation Term="OData.Description" String="An external TACACS+ service."/>
539 <Annotation Term="OData.LongDescription" String="The external account provider shall be an RFC8907-conformant service. The ServiceAddresses format shall contain a set of host:port that correspond to a TACACS+ service and where the format for host and port are defined in RFC3986."/>
540 <Annotation Term="Redfish.Revisions">
541 <Collection>
542 <Record>
543 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
544 <PropertyValue Property="Version" String="v1_8_0"/>
545 </Record>
546 </Collection>
547 </Annotation>
548 </Member>
Gunnar Mills9d424662021-09-22 21:56:16 -0500549 <Member Name="OAuth2">
550 <Annotation Term="OData.Description" String="An external OAuth 2.0 service."/>
551 <Annotation Term="OData.LongDescription" String="The external account provider shall be an RFC6749-conformant service. The ServiceAddresses format shall contain a set of URIs that correspond to the RFC8414-defined metadata for the OAuth 2.0 service."/>
552 <Annotation Term="Redfish.Revisions">
553 <Collection>
554 <Record>
555 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
556 <PropertyValue Property="Version" String="v1_10_0"/>
557 </Record>
558 </Collection>
559 </Annotation>
560 </Member>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700561 </EnumType>
562
563 <ComplexType Name="Authentication">
Ed Tanouscb103132019-10-08 11:34:22 -0700564 <Annotation Term="OData.Description" String="The information required to authenticate to the external service."/>
565 <Annotation Term="OData.LongDescription" String="This type shall contain the information required to authenticate to the external service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700566 <Property Name="AuthenticationType" Type="AccountService.v1_3_0.AuthenticationTypes">
567 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700568 <Annotation Term="OData.Description" String="The type of authentication used to connect to the external account provider."/>
569 <Annotation Term="OData.LongDescription" String="This property shall contain the type of authentication used to connect to the external account provider."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700570 </Property>
571 <Property Name="Username" Type="Edm.String" Nullable="false">
572 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500573 <Annotation Term="OData.Description" String="The user name for the service."/>
574 <Annotation Term="OData.LongDescription" String="This property shall contain the user name for this service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700575 </Property>
576 <Property Name="Password" Type="Edm.String">
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800577 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Write"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500578 <Annotation Term="OData.Description" String="The password for this service. A PATCH or PUT request writes the password. This property is `null` in responses."/>
579 <Annotation Term="OData.LongDescription" String="This property shall contain the password for this service. A PATCH or PUT operation writes the password. The value shall be `null` in responses."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700580 </Property>
581 <Property Name="Token" Type="Edm.String">
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800582 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Write"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500583 <Annotation Term="OData.Description" String="The token for this service. A PATCH or PUT operation writes the token. This property is `null` in responses."/>
584 <Annotation Term="OData.LongDescription" String="This property shall contain the token for this service. A PATCH or PUT operation writes the token. The value shall be `null` in responses."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700585 </Property>
586 <Property Name="KerberosKeytab" Type="Edm.String">
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800587 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Write"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500588 <Annotation Term="OData.Description" String="The Base64-encoded version of the Kerberos keytab for this service. A PATCH or PUT operation writes the keytab. This property is `null` in responses."/>
589 <Annotation Term="OData.LongDescription" String="This property shall contain a Base64-encoded version of the Kerberos keytab for this service. A PATCH or PUT operation writes the keytab. The value shall be `null` in responses."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700590 </Property>
Ed Tanous530520e2019-01-02 13:41:37 -0800591 <Property Name="Oem" Type="Resource.Oem" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -0700592 <Annotation Term="OData.Description" String="The OEM extension property."/>
593 <Annotation Term="OData.LongDescription" String="This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800594 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700595 </ComplexType>
596
597 <EnumType Name="AuthenticationTypes">
598 <Member Name="Token">
599 <Annotation Term="OData.Description" String="An opaque authentication token."/>
600 </Member>
601 <Member Name="KerberosKeytab">
Ed Tanouscb103132019-10-08 11:34:22 -0700602 <Annotation Term="OData.Description" String="A Kerberos keytab."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700603 </Member>
604 <Member Name="UsernameAndPassword">
Ed Tanouscb103132019-10-08 11:34:22 -0700605 <Annotation Term="OData.Description" String="A user name and password combination."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700606 </Member>
607 <Member Name="OEM">
Ed Tanouscb103132019-10-08 11:34:22 -0700608 <Annotation Term="OData.Description" String="An OEM-specific authentication mechanism."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700609 </Member>
610 </EnumType>
611
612 <ComplexType Name="LDAPService">
Ed Tanouscb103132019-10-08 11:34:22 -0700613 <Annotation Term="OData.Description" String="The settings required to parse a generic LDAP service."/>
614 <Annotation Term="OData.LongDescription" String="This type shall contain all required settings to parse a generic LDAP service."/>
615 <Property Name="SearchSettings" Type="AccountService.v1_3_0.LDAPSearchSettings" Nullable="false">
616 <Annotation Term="OData.Description" String="The required settings to search an external LDAP service."/>
617 <Annotation Term="OData.LongDescription" String="This property shall contain the required settings to search an external LDAP service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700618 </Property>
Ed Tanous530520e2019-01-02 13:41:37 -0800619 <Property Name="Oem" Type="Resource.Oem" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -0700620 <Annotation Term="OData.Description" String="The OEM extension property."/>
621 <Annotation Term="OData.LongDescription" String="This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800622 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700623 </ComplexType>
624
625 <ComplexType Name="LDAPSearchSettings">
Ed Tanouscb103132019-10-08 11:34:22 -0700626 <Annotation Term="OData.Description" String="The settings to search a generic LDAP service."/>
627 <Annotation Term="OData.LongDescription" String="This type shall contain all required settings to search a generic LDAP service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700628 <Property Name="BaseDistinguishedNames" Type="Collection(Edm.String)">
629 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700630 <Annotation Term="OData.Description" String="The base distinguished names to use to search an external LDAP service."/>
631 <Annotation Term="OData.LongDescription" String="This property shall contain an array of base distinguished names to use to search an external LDAP service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700632 </Property>
633 <Property Name="UsernameAttribute" Type="Edm.String">
634 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700635 <Annotation Term="OData.Description" String="The attribute name that contains the LDAP user name entry."/>
636 <Annotation Term="OData.LongDescription" String="This property shall contain the attribute name that contains the LDAP user name."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700637 </Property>
638 <Property Name="GroupNameAttribute" Type="Edm.String">
639 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700640 <Annotation Term="OData.Description" String="The attribute name that contains the LDAP group name entry."/>
641 <Annotation Term="OData.LongDescription" String="This property shall contain the attribute name that contains the LDAP group name."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700642 </Property>
643 <Property Name="GroupsAttribute" Type="Edm.String">
644 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700645 <Annotation Term="OData.Description" String="The attribute name that contains the groups for a user on the LDAP user entry."/>
646 <Annotation Term="OData.LongDescription" String="This property shall contain the attribute name that contains the groups for an LDAP user entry."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700647 </Property>
648 </ComplexType>
649
650 <ComplexType Name="RoleMapping">
Gunnar Mills844b4152020-06-22 12:44:09 -0500651 <Annotation Term="OData.Description" String="The mapping rules that are used to convert the external account providers account information to the local Redfish role."/>
652 <Annotation Term="OData.LongDescription" String="This type shall contain mapping rules that are used to convert the external account providers account information to the local Redfish role."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700653 <Property Name="RemoteGroup" Type="Edm.String">
654 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500655 <Annotation Term="OData.Description" String="The name of the remote group, or the remote role in the case of a Redfish service, that maps to the local Redfish role to which this entity links."/>
656 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the remote group, or the remote role in the case of a Redfish service, that maps to the local Redfish role to which this entity links."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700657 </Property>
658 <Property Name="RemoteUser" Type="Edm.String">
659 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500660 <Annotation Term="OData.Description" String="The name of the remote user that maps to the local Redfish role to which this entity links."/>
661 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the remote user that maps to the local Redfish role to which this entity links."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700662 </Property>
663 <Property Name="LocalRole" Type="Edm.String">
664 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500665 <Annotation Term="OData.Description" String="The name of the local Redfish role to which to map the remote user or group."/>
666 <Annotation Term="OData.LongDescription" String="This property shall contain the RoleId property value within a role resource on this Redfish service to which to map the remote user or group."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700667 </Property>
Ed Tanous530520e2019-01-02 13:41:37 -0800668 <Property Name="Oem" Type="Resource.Oem" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -0700669 <Annotation Term="OData.Description" String="The OEM extension property."/>
670 <Annotation Term="OData.LongDescription" String="This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800671 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700672 </ComplexType>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700673 </Schema>
674
Ed Tanous530520e2019-01-02 13:41:37 -0800675 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_3_1">
676 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
677 <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."/>
678 <EntityType Name="AccountService" BaseType="AccountService.v1_3_0.AccountService"/>
679 </Schema>
680
Ed Tanouscb103132019-10-08 11:34:22 -0700681 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_3_2">
682 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500683 <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. It also clarifies property descriptions in LDAPSearchSettings and adds a missing term to several properties to disallow them from being `null`."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700684 <EntityType Name="AccountService" BaseType="AccountService.v1_3_1.AccountService"/>
685 </Schema>
686
687 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_3_3">
688 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
689 <Annotation Term="OData.Description" String="This version was created to update the description of the Password, Token, and KerberosKeytab properties. It was also created to clarify the usage of the LDAPService property."/>
690 <EntityType Name="AccountService" BaseType="AccountService.v1_3_2.AccountService"/>
691 </Schema>
692
Gunnar Mills844b4152020-06-22 12:44:09 -0500693 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_3_4">
694 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
695 <Annotation Term="OData.Description" String="This version was created to clarify the description for AuthFailureLoggingThreshold."/>
696 <EntityType Name="AccountService" BaseType="AccountService.v1_3_3.AccountService"/>
697 </Schema>
698
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500699 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_3_5">
700 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
701 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions for MinPasswordLength and MaxPasswordLength to state they do not apply to accounts from external account providers. It was also updated to make MinPasswordLength and MaxPasswordLength writable. The description for AuthFailureLoggingThreshold was also updated to clarify that the threshold applies to authentication failures per account."/>
702 <EntityType Name="AccountService" BaseType="AccountService.v1_3_4.AccountService"/>
703 </Schema>
704
Gunnar Mills262d7d42021-01-20 16:28:41 -0600705 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_3_6">
706 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
707 <Annotation Term="OData.Description" String="This version was created to fix typos in descriptions and long descriptions."/>
708 <EntityType Name="AccountService" BaseType="AccountService.v1_3_5.AccountService"/>
709 </Schema>
710
711 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_3_7">
712 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
713 <Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
714 <EntityType Name="AccountService" BaseType="AccountService.v1_3_6.AccountService"/>
715 </Schema>
716
Gunnar Mills10f270b2021-05-19 15:34:06 -0500717 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_3_8">
718 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
719 <Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
720 <EntityType Name="AccountService" BaseType="AccountService.v1_3_7.AccountService"/>
721 </Schema>
722
Gunnar Mills9d424662021-09-22 21:56:16 -0500723 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_3_9">
724 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
725 <Annotation Term="OData.Description" String="This version was created to clarify that services are allowed to protect accounts to avoid deadlock conditions."/>
726 <EntityType Name="AccountService" BaseType="AccountService.v1_3_8.AccountService"/>
727 </Schema>
728
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800729 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_3_10">
730 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
731 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
732 <EntityType Name="AccountService" BaseType="AccountService.v1_3_9.AccountService"/>
733 </Schema>
734
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600735 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_4_0">
736 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
737 <Annotation Term="Redfish.Release" String="2018.3"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500738
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600739 <EntityType Name="AccountService" BaseType="AccountService.v1_3_1.AccountService"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500740
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600741 <ComplexType Name="ExternalAccountProvider" BaseType="AccountService.v1_3_0.ExternalAccountProvider">
742 <NavigationProperty Name="Certificates" Type="CertificateCollection.CertificateCollection" ContainsTarget="true" Nullable="false">
743 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700744 <Annotation Term="OData.Description" String="The link to a collection of certificates that the external account provider uses."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500745 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type CertificateCollection that contains certificates the external account provider uses."/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600746 <Annotation Term="OData.AutoExpandReferences"/>
747 </NavigationProperty>
748 </ComplexType>
749 </Schema>
750
Ed Tanouscb103132019-10-08 11:34:22 -0700751 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_4_1">
752 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500753 <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. It also clarifies property descriptions in LDAPSearchSettings and adds a missing term to several properties to disallow them from being `null`."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700754 <EntityType Name="AccountService" BaseType="AccountService.v1_4_0.AccountService"/>
755 </Schema>
756
757 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_4_2">
758 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
759 <Annotation Term="OData.Description" String="This version was created to update the description of the Password, Token, and KerberosKeytab properties. It was also created to clarify the usage of the LDAPService property."/>
760 <EntityType Name="AccountService" BaseType="AccountService.v1_4_1.AccountService"/>
761 </Schema>
762
Gunnar Mills844b4152020-06-22 12:44:09 -0500763 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_4_3">
764 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
765 <Annotation Term="OData.Description" String="This version was created to clarify the description for AuthFailureLoggingThreshold."/>
766 <EntityType Name="AccountService" BaseType="AccountService.v1_4_2.AccountService"/>
767 </Schema>
768
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500769 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_4_4">
770 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
771 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions for MinPasswordLength and MaxPasswordLength to state they do not apply to accounts from external account providers. It was also updated to make MinPasswordLength and MaxPasswordLength writable. The description for AuthFailureLoggingThreshold was also updated to clarify that the threshold applies to authentication failures per account."/>
772 <EntityType Name="AccountService" BaseType="AccountService.v1_4_3.AccountService"/>
773 </Schema>
774
Gunnar Mills262d7d42021-01-20 16:28:41 -0600775 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_4_5">
776 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
777 <Annotation Term="OData.Description" String="This version was created to fix typos in descriptions and long descriptions."/>
778 <EntityType Name="AccountService" BaseType="AccountService.v1_4_4.AccountService"/>
779 </Schema>
780
Gunnar Mills10f270b2021-05-19 15:34:06 -0500781 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_4_6">
782 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
783 <Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
784 <EntityType Name="AccountService" BaseType="AccountService.v1_4_5.AccountService"/>
785 </Schema>
786
Gunnar Mills9d424662021-09-22 21:56:16 -0500787 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_4_7">
788 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
789 <Annotation Term="OData.Description" String="This version was created to clarify that services are allowed to protect accounts to avoid deadlock conditions."/>
790 <EntityType Name="AccountService" BaseType="AccountService.v1_4_6.AccountService"/>
791 </Schema>
792
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800793 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_4_8">
794 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
795 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
796 <EntityType Name="AccountService" BaseType="AccountService.v1_4_7.AccountService"/>
797 </Schema>
798
Ed Tanouscb103132019-10-08 11:34:22 -0700799 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_5_0">
800 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
801 <Annotation Term="Redfish.Release" String="2019.1"/>
802 <Annotation Term="OData.Description" String="This version was created to add the AccountLockoutCounterResetEnabled property, update the long descriptions of the AccountLockoutCounterResetAfter and AccountLockoutDuration properties, and deprecate the AccountProviderType property."/>
803
804 <EntityType Name="AccountService" BaseType="AccountService.v1_4_1.AccountService">
805 <Property Name="AccountLockoutCounterResetEnabled" Type="Edm.Boolean" Nullable="false">
806 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
807 <Annotation Term="OData.Description" String="An indication of whether the threshold counter is reset after AccountLockoutCounterResetAfter expires. If `true`, it is reset. If `false`, only a successful login resets the threshold counter and if the user reaches the AccountLockoutThreshold limit, the account will be locked out indefinitely and only an administrator-issued reset clears the threshold counter. If this property is absent, the default is `true`."/>
808 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the threshold counter is reset after the AccountLockoutCounterResetAfter expires. If `true`, it is reset. If `false`, only a successful login resets the threshold counter and if the user reaches the AccountLockoutThreshold limit, the account shall be locked out indefinitely and only an administrator-issued reset clears the threshold counter. If this property is absent, the default is `true`."/>
809 </Property>
810 </EntityType>
811 </Schema>
812
813 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_5_1">
814 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
815 <Annotation Term="OData.Description" String="This version was created to update the description of the Password, Token, and KerberosKeytab properties. It was also created to clarify the usage of the LDAPService property."/>
816 <EntityType Name="AccountService" BaseType="AccountService.v1_5_0.AccountService"/>
817 </Schema>
818
Gunnar Mills844b4152020-06-22 12:44:09 -0500819 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_5_2">
820 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
821 <Annotation Term="OData.Description" String="This version was created to clarify the description for AuthFailureLoggingThreshold."/>
822 <EntityType Name="AccountService" BaseType="AccountService.v1_5_1.AccountService"/>
823 </Schema>
824
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500825 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_5_3">
826 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
827 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions for MinPasswordLength and MaxPasswordLength to state they do not apply to accounts from external account providers. It was also updated to make MinPasswordLength and MaxPasswordLength writable. The description for AuthFailureLoggingThreshold was also updated to clarify that the threshold applies to authentication failures per account."/>
828 <EntityType Name="AccountService" BaseType="AccountService.v1_5_2.AccountService"/>
829 </Schema>
830
Gunnar Mills262d7d42021-01-20 16:28:41 -0600831 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_5_4">
832 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
833 <Annotation Term="OData.Description" String="This version was created to fix typos in descriptions and long descriptions."/>
834 <EntityType Name="AccountService" BaseType="AccountService.v1_5_3.AccountService"/>
835 </Schema>
836
Gunnar Mills10f270b2021-05-19 15:34:06 -0500837 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_5_5">
838 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
839 <Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
840 <EntityType Name="AccountService" BaseType="AccountService.v1_5_4.AccountService"/>
841 </Schema>
842
Gunnar Mills9d424662021-09-22 21:56:16 -0500843 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_5_6">
844 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
845 <Annotation Term="OData.Description" String="This version was created to clarify that services are allowed to protect accounts to avoid deadlock conditions."/>
846 <EntityType Name="AccountService" BaseType="AccountService.v1_5_5.AccountService"/>
847 </Schema>
848
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800849 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_5_7">
850 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
851 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
852 <EntityType Name="AccountService" BaseType="AccountService.v1_5_6.AccountService"/>
853 </Schema>
854
Ed Tanouscb103132019-10-08 11:34:22 -0700855 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_6_0">
856 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
857 <Annotation Term="Redfish.Release" String="2019.2"/>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600858 <Annotation Term="OData.Description" String="This version was created to add LocalFirst to the LocalAccountAuth enumeration."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700859
860 <EntityType Name="AccountService" BaseType="AccountService.v1_5_1.AccountService"/>
861 </Schema>
862
Gunnar Mills844b4152020-06-22 12:44:09 -0500863 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_6_1">
864 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
865 <Annotation Term="OData.Description" String="This version was created to clarify the description for AuthFailureLoggingThreshold."/>
866 <EntityType Name="AccountService" BaseType="AccountService.v1_6_0.AccountService"/>
867 </Schema>
868
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500869 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_6_2">
870 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
871 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions for MinPasswordLength and MaxPasswordLength to state they do not apply to accounts from external account providers. It was also updated to make MinPasswordLength and MaxPasswordLength writable. The description for AuthFailureLoggingThreshold was also updated to clarify that the threshold applies to authentication failures per account."/>
872 <EntityType Name="AccountService" BaseType="AccountService.v1_6_1.AccountService"/>
873 </Schema>
874
Gunnar Mills262d7d42021-01-20 16:28:41 -0600875 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_6_3">
876 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
877 <Annotation Term="OData.Description" String="This version was created to fix typos in descriptions and long descriptions."/>
878 <EntityType Name="AccountService" BaseType="AccountService.v1_6_2.AccountService"/>
879 </Schema>
880
Gunnar Mills10f270b2021-05-19 15:34:06 -0500881 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_6_4">
882 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
883 <Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
884 <EntityType Name="AccountService" BaseType="AccountService.v1_6_3.AccountService"/>
885 </Schema>
886
Gunnar Mills9d424662021-09-22 21:56:16 -0500887 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_6_5">
888 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
889 <Annotation Term="OData.Description" String="This version was created to clarify that services are allowed to protect accounts to avoid deadlock conditions."/>
890 <EntityType Name="AccountService" BaseType="AccountService.v1_6_4.AccountService"/>
891 </Schema>
892
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800893 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_6_6">
894 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
895 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
896 <EntityType Name="AccountService" BaseType="AccountService.v1_6_5.AccountService"/>
897 </Schema>
898
Gunnar Mills09b9d452020-02-11 13:27:39 -0600899 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_7_0">
900 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
901 <Annotation Term="Redfish.Release" String="2019.4"/>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600902
903 <EntityType Name="AccountService" BaseType="AccountService.v1_6_0.AccountService"/>
904
905 <ComplexType Name="ExternalAccountProvider" BaseType="AccountService.v1_4_0.ExternalAccountProvider">
906 <Property Name="PasswordSet" Type="Edm.Boolean" Nullable="false">
907 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
908 <Annotation Term="OData.Description" String="Indicates if the Password property is set."/>
909 <Annotation Term="OData.LongDescription" String="This property shall contain `true` if a valid value was provided for the Password property. Otherwise, the property shall contain `false`."/>
910 </Property>
911 </ComplexType>
912 </Schema>
913
Gunnar Mills844b4152020-06-22 12:44:09 -0500914 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_7_1">
915 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
916 <Annotation Term="OData.Description" String="This version was created to clarify the description for AuthFailureLoggingThreshold."/>
917 <EntityType Name="AccountService" BaseType="AccountService.v1_7_0.AccountService"/>
918 </Schema>
919
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500920 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_7_2">
921 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
922 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions for MinPasswordLength and MaxPasswordLength to state they do not apply to accounts from external account providers. It was also updated to make MinPasswordLength and MaxPasswordLength writable. The description for AuthFailureLoggingThreshold was also updated to clarify that the threshold applies to authentication failures per account."/>
923 <EntityType Name="AccountService" BaseType="AccountService.v1_7_1.AccountService"/>
924 </Schema>
925
Gunnar Mills262d7d42021-01-20 16:28:41 -0600926 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_7_3">
927 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
928 <Annotation Term="OData.Description" String="This version was created to fix typos in descriptions and long descriptions."/>
929 <EntityType Name="AccountService" BaseType="AccountService.v1_7_2.AccountService"/>
930 </Schema>
931
Gunnar Mills10f270b2021-05-19 15:34:06 -0500932 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_7_4">
933 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
934 <Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
935 <EntityType Name="AccountService" BaseType="AccountService.v1_7_3.AccountService"/>
936 </Schema>
937
Gunnar Mills9d424662021-09-22 21:56:16 -0500938 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_7_5">
939 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
940 <Annotation Term="OData.Description" String="This version was created to clarify that services are allowed to protect accounts to avoid deadlock conditions."/>
941 <EntityType Name="AccountService" BaseType="AccountService.v1_7_4.AccountService"/>
942 </Schema>
943
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800944 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_7_6">
945 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
946 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
947 <EntityType Name="AccountService" BaseType="AccountService.v1_7_5.AccountService"/>
948 </Schema>
949
Gunnar Mills262d7d42021-01-20 16:28:41 -0600950 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_8_0">
951 <Annotation Term="Redfish.Release" String="2020.4"/>
952 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
953 <Annotation Term="OData.Description" String="This version was created to add TACACS+ support and SupportedAccountTypes."/>
954
955 <EntityType Name="AccountService" BaseType="AccountService.v1_7_3.AccountService">
956 <Property Name="TACACSplus" Type="AccountService.v1_8_0.ExternalAccountProvider">
957 <Annotation Term="OData.Description" String="The first TACACS+ external account provider that this account service supports."/>
958 <Annotation Term="OData.LongDescription" String="This property shall contain the first TACACS+ external account provider that this account service supports. If the account service supports one or more TACACS+ services as an external account provider, this entity shall be populated by default. This entity shall not be present in the additional external account providers resource collection."/>
Gunnar Mills10f270b2021-05-19 15:34:06 -0500959 </Property>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600960 <Property Name="SupportedAccountTypes" Type="Collection(ManagerAccount.AccountTypes)" Nullable="false">
961 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
962 <Annotation Term="OData.Description" String="The account types supported by the service."/>
963 <Annotation Term="OData.LongDescription" String="This property shall contain an array of the account types supported by the service."/>
964 </Property>
965 <Property Name="SupportedOEMAccountTypes" Type="Collection(Edm.String)" Nullable="false">
966 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
967 <Annotation Term="OData.Description" String="The OEM account types supported by the service."/>
968 <Annotation Term="OData.LongDescription" String="This property shall contain an array of the OEM account types supported by the service."/>
969 </Property>
970 <Property Name="RestrictedPrivileges" Type="Collection(Privileges.PrivilegeType)" Nullable="false">
971 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
972 <Annotation Term="OData.Description" String="The set of restricted Redfish privileges."/>
973 <Annotation Term="OData.LongDescription" String="This property shall contain an array of Redfish privileges that are restricted by the service."/>
974 </Property>
975 <Property Name="RestrictedOemPrivileges" Type="Collection(Edm.String)" Nullable="false">
976 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
977 <Annotation Term="OData.Description" String="The set of restricted OEM privileges."/>
978 <Annotation Term="OData.LongDescription" String="This property shall contain an array of OEM privileges that are restricted by the service."/>
979 </Property>
980 </EntityType>
981
982 <ComplexType Name="ExternalAccountProvider" BaseType="AccountService.v1_7_0.ExternalAccountProvider">
983 <Property Name="TACACSplusService" Type="AccountService.v1_8_0.TACACSplusService">
984 <Annotation Term="OData.Description" String="The additional information needed to parse a TACACS+ services."/>
Gunnar Mills10f270b2021-05-19 15:34:06 -0500985 <Annotation Term="OData.LongDescription" String="This property shall contain additional information needed to parse a TACACS+ services. This property should only be present inside a TACACSplus property."/>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600986 </Property>
987 <Property Name="Priority" Type="Edm.Int64">
988 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
989 <Annotation Term="OData.Description" String="The authentication priority for the external account provider."/>
990 <Annotation Term="OData.LongDescription" String="This property shall contain the assigned priority for the specified external account provider. The value `0` value shall indicate the highest priority. Increasing values shall represent decreasing priority. If an external provider does not have a priority assignment or two or more external providers have the same priority, the behavior shall be determined by the Redfish service. The priority is used to determine the order of authentication and authorization for each external account provider."/>
991 <Annotation Term="Validation.Minimum" Int="0"/>
992 </Property>
993 </ComplexType>
994
995 <ComplexType Name="Authentication" BaseType="AccountService.v1_3_0.Authentication">
996 <Property Name="EncryptionKey" Type="Edm.String">
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800997 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Write"/>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600998 <Annotation Term="OData.Description" String="Specifies the encryption key."/>
999 <Annotation Term="OData.LongDescription" String="This property shall contain the value of a symmetric encryption key for account services that support some form of encryption, obfuscation, or authentication such as TACACS+. The value shall be `null` in responses. The property shall accept a hexadecimal string whose length depends on the external account service, such as TACACS+. A TACACS+ service shall use this property to specify the secret key as defined in RFC8907."/>
1000 <Annotation Term="Validation.Pattern" String="^[0-9a-fA-F]+$"/>
1001 </Property>
1002 <Property Name="EncryptionKeySet" Type="Edm.Boolean">
1003 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1004 <Annotation Term="OData.Description" String="Indicates if the EncryptionKey property is set."/>
1005 <Annotation Term="OData.LongDescription" String="This property shall contain `true` if a valid value was provided for the EncryptionKey property. Otherwise, the property shall contain `false`. For a TACACS+ service, the value `false` shall indicate data obfuscation, as defined in section 4.5 of RFC8907, is disabled."/>
1006 </Property>
1007 </ComplexType>
1008
1009 <ComplexType Name="TACACSplusService">
1010 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
1011 <Annotation Term="OData.Description" String="Various settings to parse a TACACS+ service."/>
1012 <Annotation Term="OData.LongDescription" String="This type shall contain settings for parsing a TACACS+ service."/>
1013 <Property Name="PrivilegeLevelArgument" Type="Edm.String">
1014 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1015 <Annotation Term="OData.Description" String="Indicates the name of the TACACS+ argument name in an authorization request."/>
1016 <Annotation Term="OData.LongDescription" String="This property shall specify the name of the argument in a TACACS+ Authorization REPLY packet body, as defined in RFC8907, that contains the user's privilege level."/>
1017 </Property>
1018 <Property Name="PasswordExchangeProtocols" Type="Collection(AccountService.v1_8_0.TACACSplusPasswordExchangeProtocol)">
1019 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1020 <Annotation Term="OData.Description" String="Indicates the allowed TACACS+ password exchange protocols."/>
1021 <Annotation Term="OData.LongDescription" String="This property shall indicate all the allowed TACACS+ password exchange protocol described under section 5.4.2 of RFC8907."/>
1022 </Property>
1023 </ComplexType>
1024
1025 <EnumType Name="TACACSplusPasswordExchangeProtocol">
1026 <Member Name="ASCII">
1027 <Annotation Term="OData.Description" String="The ASCII Login method."/>
1028 <Annotation Term="OData.LongDescription" String="This value shall indicate the ASCII Login flow as described under section 5.4.2 of RFC8907."/>
1029 </Member>
1030 <Member Name="PAP">
1031 <Annotation Term="OData.Description" String="The PAP Login method."/>
1032 <Annotation Term="OData.LongDescription" String="This value shall indicate the PAP Login flow as described under section 5.4.2 of RFC8907."/>
1033 </Member>
1034 <Member Name="CHAP">
1035 <Annotation Term="OData.Description" String="The CHAP Login method."/>
1036 <Annotation Term="OData.LongDescription" String="This value shall indicate the CHAP Login flow as described under section 5.4.2 of RFC8907."/>
1037 </Member>
1038 <Member Name="MSCHAPv1">
1039 <Annotation Term="OData.Description" String="The MS-CHAP v1 Login method."/>
1040 <Annotation Term="OData.LongDescription" String="This value shall indicate the MS-CHAP v1 Login flow as described under section 5.4.2 of RFC8907."/>
1041 </Member>
1042 <Member Name="MSCHAPv2">
1043 <Annotation Term="OData.Description" String="The MS-CHAP v2 Login method."/>
1044 <Annotation Term="OData.LongDescription" String="This value shall indicate the MS-CHAP v2 Login flow as described under section 5.4.2 of RFC8907."/>
1045 </Member>
1046 </EnumType>
1047 </Schema>
1048
Gunnar Mills10f270b2021-05-19 15:34:06 -05001049 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_8_1">
1050 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1051 <Annotation Term="OData.Description" String="This version was created to correct various description to use proper normative terminology."/>
1052 <EntityType Name="AccountService" BaseType="AccountService.v1_8_0.AccountService"/>
1053 </Schema>
1054
Gunnar Mills9d424662021-09-22 21:56:16 -05001055 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_8_2">
1056 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1057 <Annotation Term="OData.Description" String="This version was created to clarify that services are allowed to protect accounts to avoid deadlock conditions."/>
1058 <EntityType Name="AccountService" BaseType="AccountService.v1_8_1.AccountService"/>
1059 </Schema>
1060
Ed Tanousa8d8f9d2023-01-26 13:57:00 -08001061 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_8_3">
1062 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1063 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
1064 <EntityType Name="AccountService" BaseType="AccountService.v1_8_2.AccountService"/>
1065 </Schema>
1066
Gunnar Mills10f270b2021-05-19 15:34:06 -05001067 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_9_0">
1068 <Annotation Term="Redfish.Release" String="2021.1"/>
1069 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1070 <Annotation Term="OData.Description" String="This version was created to add the property PasswordExpirationDays."/>
1071
1072 <EntityType Name="AccountService" BaseType="AccountService.v1_8_0.AccountService">
1073 <Property Name="PasswordExpirationDays" Type="Edm.Int64">
1074 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1075 <Annotation Term="OData.Description" String="The number of days before account passwords in this account service will expire."/>
1076 <Annotation Term="OData.LongDescription" String="This property shall contain the number of days before account passwords in this account service will expire. The value shall be applied during account creation and password modification unless the PasswordExpiration property is provided. The value `null` shall indicate that account passwords never expire. This property does not apply to accounts from external account providers."/>
1077 </Property>
1078 </EntityType>
1079 </Schema>
1080
Gunnar Mills9d424662021-09-22 21:56:16 -05001081 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_9_1">
1082 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1083 <Annotation Term="OData.Description" String="This version was created to clarify that services are allowed to protect accounts to avoid deadlock conditions."/>
1084 <EntityType Name="AccountService" BaseType="AccountService.v1_9_0.AccountService"/>
1085 </Schema>
1086
Ed Tanousa8d8f9d2023-01-26 13:57:00 -08001087 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_9_2">
1088 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1089 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
1090 <EntityType Name="AccountService" BaseType="AccountService.v1_9_0.AccountService"/>
1091 </Schema>
1092
Gunnar Mills9d424662021-09-22 21:56:16 -05001093 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_10_0">
1094 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1095 <Annotation Term="Redfish.Release" String="2021.2"/>
1096
1097 <EntityType Name="AccountService" BaseType="AccountService.v1_9_1.AccountService">
1098 <Property Name="OAuth2" Type="AccountService.v1_10_0.ExternalAccountProvider">
1099 <Annotation Term="OData.Description" String="The first OAuth 2.0 external account provider that this account service supports."/>
1100 <Annotation Term="OData.LongDescription" String="This property shall contain the first OAuth 2.0 external account provider that this account service supports. If the account service supports one or more OAuth 2.0 services as an external account provider, this entity shall be populated by default. This entity shall not be present in the additional external account providers resource collection."/>
1101 </Property>
1102 </EntityType>
1103
1104 <ComplexType Name="ExternalAccountProvider" BaseType="AccountService.v1_8_0.ExternalAccountProvider">
1105 <Property Name="OAuth2Service" Type="AccountService.v1_10_0.OAuth2Service">
1106 <Annotation Term="OData.Description" String="The additional information needed to parse an OAuth 2.0 service."/>
1107 <Annotation Term="OData.LongDescription" String="This property shall contain additional information needed to parse an OAuth 2.0 service. This property should only be present inside an OAuth2 property."/>
1108 </Property>
1109 </ComplexType>
1110
1111 <ComplexType Name="OAuth2Service">
1112 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
1113 <Annotation Term="OData.Description" String="Various settings to parse an OAuth 2.0 service."/>
1114 <Annotation Term="OData.LongDescription" String="This type shall contain settings for parsing an OAuth 2.0 service."/>
1115 <Property Name="Mode" Type="AccountService.v1_10_0.OAuth2Mode" Nullable="false">
1116 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1117 <Annotation Term="OData.Description" String="The mode of operation for token validation."/>
1118 <Annotation Term="OData.LongDescription" String="This property shall contain the mode of operation for token validation."/>
1119 </Property>
1120 <Property Name="Issuer" Type="Edm.String">
1121 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Asmitha Karunanithi009c6452022-09-22 01:07:59 -05001122 <Annotation Term="OData.Description" String="The issuer string of the OAuth 2.0 service. Clients should configure this property if Mode contains `Offline`."/>
1123 <Annotation Term="OData.LongDescription" String="This property shall contain the RFC8414-defined issuer string of the OAuth 2.0 service. If the Mode property contains the value `Discovery`, this property shall contain the value of the `issuer` string from the OAuth 2.0 service's metadata and this property shall be read-only. Clients should configure this property if Mode contains `Offline`."/>
Gunnar Mills9d424662021-09-22 21:56:16 -05001124 </Property>
1125 <Property Name="Audience" Type="Collection(Edm.String)" Nullable="false">
1126 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1127 <Annotation Term="OData.Description" String="The allowable audience strings of the Redfish service."/>
1128 <Annotation Term="OData.LongDescription" String="This property shall contain an array of allowable RFC7519-defined audience strings of the Redfish service. The values shall uniquely identify the Redfish service. For example, a MAC address or UUID for the manager can uniquely identify the service."/>
1129 </Property>
1130 <Property Name="OAuthServiceSigningKeys" Type="Edm.String">
1131 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Asmitha Karunanithi009c6452022-09-22 01:07:59 -05001132 <Annotation Term="OData.Description" String="The Base64-encoded signing keys of the issuer of the OAuth 2.0 service. Clients should configure this property if Mode contains `Offline`."/>
Ed Tanousa8d8f9d2023-01-26 13:57:00 -08001133 <Annotation Term="OData.LongDescription" String="This property shall contain a Base64-encoded string of the RFC7517-defined signing keys of the issuer of the OAuth 2.0 service. Services shall verify the token provided in the `Authorization` header of the request with the value of this property. If the Mode property contains the value `Discovery`, this property shall contain the keys found at the URI specified by the `jwks_uri` string from the OAuth 2.0 service's metadata and this property shall be read-only. Clients should configure this property if Mode contains `Offline`."/>
Gunnar Mills9d424662021-09-22 21:56:16 -05001134 </Property>
1135 </ComplexType>
1136
1137 <EnumType Name="OAuth2Mode">
1138 <Member Name="Discovery">
1139 <Annotation Term="OData.Description" String="OAuth 2.0 service information for token validation is downloaded by the service."/>
1140 <Annotation Term="OData.LongDescription" String="This value shall indicate the service performs token validation from information found at the URIs specified by the ServiceAddresses property. Services shall implement a caching method of this information so it's not necessary to retrieve metadata and key information for every request containing a token."/>
1141 </Member>
1142 <Member Name="Offline">
Asmitha Karunanithi009c6452022-09-22 01:07:59 -05001143 <Annotation Term="OData.Description" String="OAuth 2.0 service information for token validation is configured by a client. Clients should configure the Issuer and OAuthServiceSigningKeys properties for this mode."/>
1144 <Annotation Term="OData.LongDescription" String="This value shall indicate the service performs token validation from properties configured by a client. Clients should configure the Issuer and OAuthServiceSigningKeys properties for this mode."/>
Gunnar Mills9d424662021-09-22 21:56:16 -05001145 </Member>
1146 </EnumType>
1147 </Schema>
1148
Asmitha Karunanithi009c6452022-09-22 01:07:59 -05001149 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_10_1">
1150 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1151 <Annotation Term="OData.Description" String="This version was created to give guidance to clients to describe which properties should be configured if Mode in OAuth2 contains `Offline`."/>
1152 <EntityType Name="AccountService" BaseType="AccountService.v1_10_0.AccountService"/>
1153 </Schema>
1154
Ed Tanousa8d8f9d2023-01-26 13:57:00 -08001155 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_10_2">
1156 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1157 <Annotation Term="OData.Description" String="This version was created to clarify the usage of OAuthServiceSigningKeys with token validation."/>
1158 <EntityType Name="AccountService" BaseType="AccountService.v1_10_1.AccountService"/>
1159 </Schema>
1160
1161 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_10_3">
1162 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1163 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
1164 <EntityType Name="AccountService" BaseType="AccountService.v1_10_2.AccountService"/>
1165 </Schema>
1166
Ed Tanoused761212022-09-23 15:03:29 -07001167 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_11_0">
1168 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1169 <Annotation Term="Redfish.Release" String="2022.1"/>
1170
1171 <EntityType Name="AccountService" BaseType="AccountService.v1_10_0.AccountService"/>
1172
1173 <ComplexType Name="LDAPSearchSettings" BaseType="AccountService.v1_3_0.LDAPSearchSettings">
1174 <Property Name="SSHKeyAttribute" Type="Edm.String">
1175 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1176 <Annotation Term="OData.Description" String="The attribute name that contains the LDAP user's SSH public key entry."/>
1177 <Annotation Term="OData.LongDescription" String="This property shall contain the attribute name that contains the LDAP user's SSH public key."/>
1178 </Property>
1179 </ComplexType>
1180 </Schema>
1181
Asmitha Karunanithi009c6452022-09-22 01:07:59 -05001182 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_11_1">
1183 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1184 <Annotation Term="OData.Description" String="This version was created to give guidance to clients to describe which properties should be configured if Mode in OAuth2 contains `Offline`."/>
1185 <EntityType Name="AccountService" BaseType="AccountService.v1_11_0.AccountService"/>
1186 </Schema>
1187
Ed Tanousa8d8f9d2023-01-26 13:57:00 -08001188 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_11_2">
1189 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1190 <Annotation Term="OData.Description" String="This version was created to clarify the usage of OAuthServiceSigningKeys with token validation."/>
1191 <EntityType Name="AccountService" BaseType="AccountService.v1_11_1.AccountService"/>
1192 </Schema>
1193
1194 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_11_3">
1195 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1196 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
1197 <EntityType Name="AccountService" BaseType="AccountService.v1_11_2.AccountService"/>
1198 </Schema>
1199
1200 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccountService.v1_12_0">
1201 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1202 <Annotation Term="Redfish.Release" String="2022.3"/>
1203
1204 <EntityType Name="AccountService" BaseType="AccountService.v1_11_3.AccountService">
1205 <Property Name="MultiFactorAuth" Type="AccountService.v1_12_0.MultiFactorAuth">
1206 <Annotation Term="OData.Description" String="The multi-factor authentication settings that this account service supports."/>
1207 <Annotation Term="OData.LongDescription" String="This property shall contain the multi-factor authentication settings that this account service supports."/>
1208 </Property>
1209 </EntityType>
1210
1211 <ComplexType Name="MultiFactorAuth">
1212 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
1213 <Annotation Term="OData.Description" String="Multi-factor authentication settings."/>
1214 <Annotation Term="OData.LongDescription" String="This type shall contain multi-factor authentication settings."/>
1215 <Property Name="SecurID" Type="AccountService.v1_12_0.SecurID">
1216 <Annotation Term="OData.Description" String="The settings related to RSA SecurID multi-factor authentication."/>
1217 <Annotation Term="OData.LongDescription" String="This property shall contain the settings related to RSA SecurID multi-factor authentication."/>
1218 </Property>
1219 <Property Name="GoogleAuthenticator" Type="AccountService.v1_12_0.GoogleAuthenticator">
1220 <Annotation Term="OData.Description" String="The settings related to Google Authenticator multi-factor authentication."/>
1221 <Annotation Term="OData.LongDescription" String="This property shall contain the settings related to Google Authenticator multi-factor authentication."/>
1222 </Property>
1223 <Property Name="MicrosoftAuthenticator" Type="AccountService.v1_12_0.MicrosoftAuthenticator">
1224 <Annotation Term="OData.Description" String="The settings related to Microsoft Authenticator multi-factor authentication."/>
1225 <Annotation Term="OData.LongDescription" String="This property shall contain the settings related to Microsoft Authenticator multi-factor authentication."/>
1226 </Property>
1227 <Property Name="ClientCertificate" Type="AccountService.v1_12_0.ClientCertificate">
1228 <Annotation Term="OData.Description" String="The settings related to client certificate authentication schemes such as mTLS or CAC/PIV."/>
1229 <Annotation Term="OData.LongDescription" String="This property shall contain the settings related to client certificate authentication."/>
1230 </Property>
1231 </ComplexType>
1232
1233 <ComplexType Name="SecurID">
1234 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
1235 <Annotation Term="OData.Description" String="Various settings for RSA SecurID multi-factor authentication."/>
1236 <Annotation Term="OData.LongDescription" String="This type shall contain settings for RSA SecurID multi-factor authentication."/>
1237 <Property Name="Enabled" Type="Edm.Boolean">
1238 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1239 <Annotation Term="OData.Description" String="An indication of whether multi-factor authentication with RSA SecurID is enabled."/>
1240 <Annotation Term="OData.LongDescription" String="This property shall indicate whether multi-factor authentication with RSA SecurID is enabled."/>
1241 </Property>
1242 <Property Name="ServerURI" Type="Edm.String">
1243 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1244 <Annotation Term="OData.Description" String="The URI of the RSA SecurID server."/>
1245 <Annotation Term="OData.LongDescription" String="This property shall contain the URI of the RSA SecurID server."/>
1246 <Annotation Term="OData.IsURL"/>
1247 </Property>
1248 <Property Name="ClientId" Type="Edm.String">
1249 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1250 <Annotation Term="OData.Description" String="The client ID to use when communicating with the RSA SecurID server."/>
1251 <Annotation Term="OData.LongDescription" String="This property shall contain the client ID to use when communication with the RSA SecurID server."/>
1252 </Property>
1253 <Property Name="ClientSecret" Type="Edm.String">
1254 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1255 <Annotation Term="OData.Description" String="The client secret to use when communicating with the RSA SecurID server. This property is `null` in responses."/>
1256 <Annotation Term="OData.LongDescription" String="This property shall contain the client secret to use when communication with the RSA SecurID server. The value shall be `null` in responses."/>
1257 </Property>
1258 <Property Name="ClientSecretSet" Type="Edm.Boolean" Nullable="false">
1259 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1260 <Annotation Term="OData.Description" String="Indicates if the ClientSecret property is set."/>
1261 <Annotation Term="OData.LongDescription" String="This property shall contain `true` if a valid value was provided for the ClientSecret property. Otherwise, the property shall contain `false`."/>
1262 </Property>
1263 <NavigationProperty Name="Certificates" Type="CertificateCollection.CertificateCollection" ContainsTarget="true" Nullable="false">
1264 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1265 <Annotation Term="OData.Description" String="The link to a collection of server certificates for the RSA SecurID server referenced by the ServerURI property."/>
1266 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type CertificateCollection that represent the server certificates for the RSA SecurID server referenced by the ServerURI property. Regardless of the contents of this collection, services may perform additional verification based on other factors, such as the configuration of the SecurityPolicy resource."/>
1267 <Annotation Term="OData.AutoExpandReferences"/>
1268 </NavigationProperty>
1269 </ComplexType>
1270
1271 <ComplexType Name="GoogleAuthenticator">
1272 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
1273 <Annotation Term="OData.Description" String="Various settings for Google Authenticator multi-factor authentication."/>
1274 <Annotation Term="OData.LongDescription" String="This type shall contain settings for Google Authenticator multi-factor authentication."/>
1275 <Property Name="Enabled" Type="Edm.Boolean">
1276 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1277 <Annotation Term="OData.Description" String="An indication of whether multi-factor authentication with Google Authenticator is enabled."/>
1278 <Annotation Term="OData.LongDescription" String="This property shall indicate whether multi-factor authentication with Google Authenticator is enabled."/>
1279 </Property>
1280 <Property Name="SecretKey" Type="Edm.String">
1281 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1282 <Annotation Term="OData.Description" String="The secret key to use when communicating with the Google Authenticator server. This property is `null` in responses."/>
1283 <Annotation Term="OData.LongDescription" String="This property shall contain the client key to use when communication with the Google Authenticator Server. The value shall be `null` in responses."/>
1284 </Property>
1285 <Property Name="SecretKeySet" Type="Edm.Boolean" Nullable="false">
1286 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1287 <Annotation Term="OData.Description" String="Indicates if the SecretKey property is set."/>
1288 <Annotation Term="OData.LongDescription" String="This property shall contain `true` if a valid value was provided for the SecretKey property. Otherwise, the property shall contain `false`."/>
1289 </Property>
1290 </ComplexType>
1291
1292 <ComplexType Name="MicrosoftAuthenticator">
1293 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
1294 <Annotation Term="OData.Description" String="Various settings for Microsoft Authenticator multi-factor authentication."/>
1295 <Annotation Term="OData.LongDescription" String="This type shall contain settings for Microsoft Authenticator multi-factor authentication."/>
1296 <Property Name="Enabled" Type="Edm.Boolean">
1297 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1298 <Annotation Term="OData.Description" String="An indication of whether multi-factor authentication with Microsoft Authenticator is enabled."/>
1299 <Annotation Term="OData.LongDescription" String="This property shall indicate whether multi-factor authentication with Microsoft Authenticator is enabled."/>
1300 </Property>
1301 <Property Name="SecretKey" Type="Edm.String">
1302 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1303 <Annotation Term="OData.Description" String="The secret key to use when communicating with the Microsoft Authenticator server. This property is `null` in responses."/>
1304 <Annotation Term="OData.LongDescription" String="This property shall contain the client key to use when communication with the Microsoft Authenticator server. The value shall be `null` in responses."/>
1305 </Property>
1306 <Property Name="SecretKeySet" Type="Edm.Boolean" Nullable="false">
1307 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1308 <Annotation Term="OData.Description" String="Indicates if the SecretKey property is set."/>
1309 <Annotation Term="OData.LongDescription" String="This property shall contain `true` if a valid value was provided for the SecretKey property. Otherwise, the property shall contain `false`."/>
1310 </Property>
1311 </ComplexType>
1312
1313 <ComplexType Name="ClientCertificate">
1314 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
1315 <Annotation Term="OData.Description" String="Various settings for client certificate authentication such as mTLS or CAC/PIV."/>
1316 <Annotation Term="OData.LongDescription" String="This type shall contain settings for client certificate authentication."/>
1317 <Property Name="Enabled" Type="Edm.Boolean">
1318 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1319 <Annotation Term="OData.Description" String="An indication of whether client certificate authentication is enabled."/>
1320 <Annotation Term="OData.LongDescription" String="This property shall indicate whether client certificate authentication is enabled."/>
1321 </Property>
1322 <Property Name="RespondToUnauthenticatedClients" Type="Edm.Boolean">
1323 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1324 <Annotation Term="OData.Description" String="An indication of whether the service responds to clients that do not successfully authenticate."/>
1325 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the service responds to clients that do not successfully authenticate. If this property is not supported by the service, it shall be assumed to be `true`. See the 'Client certificate authentication' clause in the Redfish Specification."/>
1326 </Property>
1327 <Property Name="CertificateMappingAttribute" Type="AccountService.v1_12_0.CertificateMappingAttribute">
1328 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1329 <Annotation Term="OData.Description" String="The client certificate attribute to map to a user."/>
1330 <Annotation Term="OData.LongDescription" String="This property shall contain the client certificate attribute to map to a user."/>
1331 </Property>
1332 <NavigationProperty Name="Certificates" Type="CertificateCollection.CertificateCollection" ContainsTarget="true" Nullable="false">
1333 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1334 <Annotation Term="OData.Description" String="The link to a collection of CA certificates used to validate client certificates."/>
1335 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type CertificateCollection that represents the CA certificates used to validate client certificates during TLS handshaking. Regardless of the contents of this collection, services may perform additional verification based on other factors, such as the configuration of the SecurityPolicy resource. If the service supports the RevokedCertificates or TrustedCertificates properties within the Client property within TLS property of the SecurityPolicy resource, the service shall verify the provided client certificate with the SecurityPolicy resource prior to verifying it with this collection."/>
1336 <Annotation Term="OData.AutoExpandReferences"/>
1337 </NavigationProperty>
1338 </ComplexType>
1339
1340 <EnumType Name="CertificateMappingAttribute">
1341 <Member Name="Whole">
1342 <Annotation Term="OData.Description" String="Match the whole certificate."/>
1343 <Annotation Term="OData.LongDescription" String="This value shall indicate the service matches the entire certificate with a Certificate resource subordinate to a ManagerAccount resource or the entire certificate matches the appropriate field from an external account provider."/>
1344 </Member>
1345 <Member Name="CommonName">
1346 <Annotation Term="OData.Description" String="Match the Common Name (CN) field in the provided certificate to the username."/>
1347 <Annotation Term="OData.LongDescription" String="This value shall indicate the service matches the RFC5280-defined 'commonName' attribute in the provided certificate to the UserName property in a ManagerAccount resource or the appropriate field from an external account provider."/>
1348 </Member>
1349 <Member Name="UserPrincipalName">
1350 <Annotation Term="OData.Description" String="Match the User Principal Name (UPN) field in the provided certificate to the username."/>
1351 <Annotation Term="OData.LongDescription" String="This value shall indicate the service matches the User Principal Name (UPN) field in the provided certificate to the UserName property in a ManagerAccount resource or the appropriate field from an external account provider."/>
1352 </Member>
1353 </EnumType>
1354
1355 <ComplexType Name="RoleMapping" BaseType="AccountService.v1_3_0.RoleMapping">
1356 <Property Name="MFABypass" Type="AccountService.MFABypass">
1357 <Annotation Term="OData.Description" String="The multi-factor authentication bypass settings."/>
1358 <Annotation Term="OData.LongDescription" String="This property shall contain the multi-factor authentication bypass settings."/>
1359 </Property>
1360 </ComplexType>
1361
1362 <ComplexType Name="MFABypass" BaseType="AccountService.MFABypass">
1363 <Property Name="BypassTypes" Type="Collection(AccountService.MFABypassType)">
1364 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1365 <Annotation Term="OData.Description" String="The types of multi-factor authentication this account or role mapping is allowed to bypass."/>
1366 <Annotation Term="OData.LongDescription" String="This property shall contain the types of multi-factor authentication this account or role mapping is allowed to bypass. An empty array shall indicate this account or role mapping cannot bypass any multi-factor authentication types that are currently enabled."/>
1367 </Property>
1368 </ComplexType>
1369 </Schema>
1370
Jason M. Billsea4aa752018-06-05 13:29:11 -07001371 </edmx:DataServices>
1372</edmx:Edmx>