{ "$id": "http://redfish.dmtf.org/schemas/v1/Role.v1_3_2.json", "$ref": "#/definitions/Role", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", "copyright": "Copyright 2014-2024 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 shall represent 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" }, "AlternateRoleId": { "description": "An equivalent role to use when this role is restricted.", "longDescription": "This property shall contain a non-restricted `RoleId` intended to be used in its place when the `Restricted` property contains the value `true`.", "readonly": true, "type": "string", "versionAdded": "v1_3_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 prevent 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 predefined by Redfish or an OEM rather than a client-defined role.", "longDescription": "This property shall indicate whether the role is predefined by Redfish or an OEM as contrasted with a client-defined 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 prevent writing to this property.", "readonly": false, "type": "array" }, "Restricted": { "description": "An indication of whether use of the role is restricted.", "longDescription": "This property shall indicate whether use of the role is restricted by a service as defined by the 'Restricted roles and restricted privileges' clause of the Redfish Specification. If this property is not present, the value shall be assumed to be `false`.", "readonly": true, "type": "boolean", "versionAdded": "v1_3_0" }, "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" } }, "language": "en", "owningEntity": "DMTF", "release": "2020.4", "title": "#Role.v1_3_2.Role" }