diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/ManagerAccount/ManagerAccount.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/ManagerAccount/ManagerAccount.json | 98 |
1 files changed, 54 insertions, 44 deletions
diff --git a/static/redfish/v1/JsonSchemas/ManagerAccount/ManagerAccount.json b/static/redfish/v1/JsonSchemas/ManagerAccount/ManagerAccount.json index 6aa4ecf364..aa893772ab 100644 --- a/static/redfish/v1/JsonSchemas/ManagerAccount/ManagerAccount.json +++ b/static/redfish/v1/JsonSchemas/ManagerAccount/ManagerAccount.json @@ -1,15 +1,15 @@ { - "$id": "http://redfish.dmtf.org/schemas/v1/ManagerAccount.v1_2_0.json", + "$id": "http://redfish.dmtf.org/schemas/v1/ManagerAccount.v1_3_1.json", "$ref": "#/definitions/ManagerAccount", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", - "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "definitions": { "Actions": { "additionalProperties": false, - "description": "The available actions for this resource.", - "longDescription": "This type shall contain the available actions for this resource.", + "description": "The available actions for this Resource.", + "longDescription": "This type shall contain the available actions for this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -25,8 +25,8 @@ "properties": { "Oem": { "$ref": "#/definitions/OemActions", - "description": "This property contains the available OEM specific actions for this resource.", - "longDescription": "This property shall contain any additional OEM actions for this resource.", + "description": "The available OEM-specific actions for this Resource.", + "longDescription": "This property shall contain the available OEM-specific actions for this Resource.", "versionAdded": "v1_1_0" } }, @@ -34,10 +34,10 @@ }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This Redfish Specification-described type shall contain links to Resources that are related to but are not contained by or subordinate to this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -53,13 +53,13 @@ "properties": { "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", - "description": "Oem extension object.", - "longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification." + "description": "The OEM extension property.", + "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." }, "Role": { "$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role", - "description": "A reference to the Role object defining Privileges for this account--returned when the resource is read. The ID of the role is the same as property RoleId.", - "longDescription": "The value of this property shall be a link to a Role object instance, and should reference the object identified by property RoleId.", + "description": "The link to the Redfish Role that defines the privileges for this account.", + "longDescription": "This property shall contain a link to a Role Resource instance, and should link to the Resource identified by the RoleId property.", "readonly": true } }, @@ -67,10 +67,10 @@ }, "ManagerAccount": { "additionalProperties": false, - "description": "The user accounts, owned by a Manager, are defined in this resource. Changes to a Manager Account may affect the current Redfish service connection if this manager is responsible for the Redfish service.", - "longDescription": "This resource shall be used to represent resources that represent the user accounts for the manager.", + "description": "The user accounts, owned by a manager, are defined in this Resource. Changes to a manager account may affect the current Redfish Service connection if this manager is responsible for the Redfish Service.", + "longDescription": "This Resource shall represent Resources that represent the user accounts for the manager.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -85,27 +85,27 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" }, "Actions": { "$ref": "#/definitions/Actions", - "description": "The available actions for this resource.", - "longDescription": "The Actions property shall contain the available actions for this resource.", + "description": "The available actions for this Resource.", + "longDescription": "The actions property shall contain the available actions for this Resource.", "versionAdded": "v1_1_0" }, "Certificates": { "$ref": "http://redfish.dmtf.org/schemas/v1/CertificateCollection.json#/definitions/CertificateCollection", - "description": "This is a reference to a collection of certificates used for this account.", - "longDescription": "The value of this property shall be a link to a collection of type CertificateCollection.", + "description": "The link to a collection of certificates used for this account.", + "longDescription": "This property shall contain a link to a Resource Collection of type CertificateCollection.", "readonly": true, "versionAdded": "v1_2_0" }, @@ -121,8 +121,8 @@ "readonly": true }, "Enabled": { - "description": "This property is used by a User Administrator to disable an account w/o having to delet the user information. When set to true, the user can login. When set to false, the account is administratively disabled and the user cannot login.", - "longDescription": "This property shall enable (if set to true) or disable (if set to false) the account for future logins. The value of Enable over-rides the locked property.", + "description": "An indication of whether an account is enabled. An administrator can disable it without deleting the user information. If `true`, the account is enabled and the user can log in. If `false`, the account is disabled and, in the future, the user cannot log in. This property overrides the Locked property.", + "longDescription": "This property shall indicate whether an account is enabled. If `true`, the account is enabled and the user can log in. If `false`, the account is disabled and, in the future, the user cannot log in. This property overrides the Locked property.", "readonly": false, "type": "boolean" }, @@ -132,12 +132,12 @@ }, "Links": { "$ref": "#/definitions/Links", - "description": "Contains references to other resources that are related to this resource.", - "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource." }, "Locked": { - "description": "This property indicates that the account has been auto-locked by the account service because the lockout threshold has been exceeded. When set to true, the account is locked. A user admin can write the property to false to manually unlock, or the account service will unlock it once the lockout duration period has passed.", - "longDescription": "This property (when set to true) shall indicate that the account service has automatically locked the account due to the accountLockoutThreshold having been exceeded. If set to true, the account is locked. If set to false, the account is not locked. A user admin shall be able to write a false to the property to clear the lockout condition, prior to the lockout duration period.", + "description": "An indication of whether the Account Service automatically locked the account because the lockout threshold was exceeded. To manually unlock the account before the lockout duration period, an administrator can change the property to `false` to clear the lockout condition.", + "longDescription": "This property shall indicate whether the Account Service automatically locked the account because the AccountLockoutThreshold was exceeded. To manually unlock the account before the lockout duration period, an administrator shall be able to change the property to `false` to clear the lockout condition.", "readonly": false, "type": "boolean" }, @@ -147,27 +147,37 @@ }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", - "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.", - "longDescription": "The value of this string shall be of the format for the reserved word *Oem*." + "description": "The OEM extension property.", + "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." }, "Password": { - "description": "This property is used with a PATCH or PUT to write the password for the account. This property is null on a GET.", - "longDescription": "The value of this property shall be the password for this account. The value shall be null for GET requests.", + "description": "The password. Use this property with a PATCH or PUT to write the password for the account. This property is `null` in responses.", + "longDescription": "This property shall contain the password for this account. The value shall be `null` in responses.", "readonly": false, "type": [ "string", "null" ] }, + "PasswordChangeRequired": { + "description": "An indication of whether the service requires that the password for this account be changed before further access to the account is allowed.", + "longDescription": "This property shall indicate whether the service requires that the password for this account be changed before further access to the account is allowed. The implementation may deny access to the service if the password has not been changed. A manager account created with an initial PasswordChangeRequired value of `true` may force a password change before first access of the account. When the Password property for this account is updated, the service shall set this property to `false`.", + "readonly": false, + "type": [ + "boolean", + "null" + ], + "versionAdded": "v1_3_0" + }, "RoleId": { - "description": "This property contains the Role for this account.", - "longDescription": "The value of this property shall be the ID (the RoleId) of the Role resource that configured for this account. The service shall reject POST, PATCH, or PUT operations that provide a RoleId that does not exist by returning HTTP 400 (Bad Request).", + "description": "The Role for this account.", + "longDescription": "This property shall contain the RoleId of the Role Resource configured for this account. The Service shall reject POST, PATCH, or PUT operations that provide a RoleId that does not exist by returning the HTTP 400 (Bad Request) status code.", "readonly": false, "type": "string" }, "UserName": { - "description": "This property contains the user name for the account.", - "longDescription": "The value of this property shall be the user name for this account.", + "description": "The user name for the account.", + "longDescription": "This property shall contain the user name for this account.", "readonly": false, "type": "string" } @@ -187,10 +197,10 @@ }, "OemActions": { "additionalProperties": true, - "description": "The available OEM specific actions for this resource.", - "longDescription": "This type shall contain any additional OEM actions for this resource.", + "description": "The available OEM-specific actions for this Resource.", + "longDescription": "This type shall contain the available OEM-specific actions for this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -208,6 +218,6 @@ } }, "owningEntity": "DMTF", - "release": "2018.3", - "title": "#ManagerAccount.v1_2_0.ManagerAccount" + "release": "2019.1", + "title": "#ManagerAccount.v1_3_1.ManagerAccount" }
\ No newline at end of file |