alexandria/alexandria/model/redfish/1.0/ManagerAccount.1.0.0.json

117 lines
7.3 KiB
JSON
Executable File

{
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.1.0.0.json",
"title": "#ManagerAccount.1.0.0.ManagerAccount",
"$ref": "#/definitions/ManagerAccount",
"definitions": {
"ManagerAccount": {
"type": "object",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"type": [
"array",
"boolean",
"number",
"null",
"object",
"string"
],
"description": "This property shall specify a valid odata or Redfish property."
}
},
"additionalProperties": false,
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/context"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/type"
},
"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*."
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id"
},
"Description": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name"
},
"Password": {
"type": [
"string",
"null"
],
"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."
},
"UserName": {
"type": "string",
"description": "This property contains the user name for the account.",
"longDescription": "The value of this property shall be the user name for this account."
},
"RoleId": {
"type": "string",
"description": "This property contains the Role for this account.",
"longDescription": "The value of this property shall be the ID of the Role resource that configured for this account."
},
"Locked": {
"type": "boolean",
"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."
},
"Enabled": {
"type": "boolean",
"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."
},
"Links": {
"type": "object",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"type": [
"array",
"boolean",
"number",
"null",
"object",
"string"
],
"description": "This property shall specify a valid odata or Redfish property."
}
},
"additionalProperties": false,
"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."
},
"Role": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Role.json#/definitions/Role",
"readonly": true,
"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."
}
},
"readonly": true,
"description": "The links object contains the links to other resources that are related to this resource."
}
},
"requiredOnCreate": [
"Password",
"UserName",
"RoleId"
],
"description": "This schema defines a user account to be used in conjunction with a manager. This will affect the 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."
}
},
"copyright": "Copyright 2014-2015 Distributed Management Task Force, Inc. (DMTF). All rights reserved."
}