blob: 5584b8ba34eb81bc8acddccd54da05d329099bf4 [file] [log] [blame]
{
"$id": "http://redfish.dmtf.org/schemas/v1/Role.v1_2_4.json",
"$ref": "#/definitions/Role",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"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.",
"patternProperties": {
"^([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",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"Oem": {
"$ref": "#/definitions/OemActions",
"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"
}
},
"type": "object"
},
"OemActions": {
"additionalProperties": true,
"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_]*$": {
"description": "This property shall specify a valid odata or Redfish property.",
"type": [
"array",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {},
"type": "object"
},
"Role": {
"additionalProperties": false,
"description": "The Role schema contains a Redfish Role to use in conjunction with a manager account.",
"longDescription": "This Resource represents the Redfish Role for the user account.",
"patternProperties": {
"^([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",
"boolean",
"integer",
"number",
"null",
"object",
"string"
]
}
},
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
},
"@odata.etag": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
},
"@odata.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": "This property shall contain the available actions for this Resource.",
"versionAdded": "v1_1_0"
},
"AssignedPrivileges": {
"description": "The Redfish privileges for this Role.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Privileges.json#/definitions/PrivilegeType"
},
"longDescription": "This property shall contain the Redfish privileges for this Role. For predefined Roles, this property shall be read-only. For custom Roles, some implementations may not allow writing to this property.",
"readonly": false,
"type": "array"
},
"Description": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
},
{
"type": "null"
}
],
"readonly": true
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"IsPredefined": {
"description": "An indication of whether the Role is a Redfish-predefined Role rather than a custom Redfish Role.",
"longDescription": "This property shall indicate whether the Role is a Redfish-predefined Role rather than a custom Redfish Role.",
"readonly": true,
"type": "boolean"
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"Oem": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/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."
},
"OemPrivileges": {
"description": "The OEM privileges for this Role.",
"items": {
"type": "string"
},
"longDescription": "This property shall contain the OEM privileges for this Role. For predefined Roles, this property shall be read-only. For custom Roles, some implementations may not allow writing to this property.",
"readonly": false,
"type": "array"
},
"RoleId": {
"description": "The name of the Role.",
"longDescription": "This property shall contain the string name of the Role. This property shall contain the same value as the Id property.",
"readonly": true,
"type": "string",
"versionAdded": "v1_2_0"
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"requiredOnCreate": [
"RoleId"
],
"type": "object"
}
},
"owningEntity": "DMTF",
"release": "2017.2",
"title": "#Role.v1_2_4.Role"
}