on-http-y1/static/DSP8010_2016.3/json-schema/Role.v1_0_2.json

OnRack Http Server

{
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_1_0.json",
    "title": "#Role.v1_0_2.Role",
    "$ref": "#/definitions/Role",
    "definitions": {
        "Role": {
            "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": {
                    "anyOf": [
                        {"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"},
                        {"type": "null"}
                    ]
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name"
                },
                "IsPredefined": {
                    "type": "boolean",
                    "readonly": true,
                    "description": "This property is used to indicate if the Role is one of the Redfish Predefined Roles vs a Custom role.",
                    "longDescription": "The value of this property shall indicate if the role is a predefined role. ."
                },
                "AssignedPrivileges": {
                    "type": "array",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Privileges.v1_0_0.json#/definitions/PrivilegeType"
                    },
                    "readonly": false,
                    "description": "The redfish privileges that this role includes.",
                    "longDescription": "The value of this property shall be the redfish privileges that the role includes. For pre-defined roles, this property shall be readOnly. For custom roles some implementations may not allow writing this property."
                },
                "OemPrivileges": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "readonly": false,
                    "description": "The OEM privileges that this role includes.",
                    "longDescription": "The value of this property shall be the OEM privileges that this role includes. For pre-defined roles, this property shall be readOnly. For custom roles some implementations may not allow writing this property."
                }
            },
            "required": [
                "Id",
                "Name"
            ],
            "description": "This resource defines a user role to be used in conjunction with a Manager Account.",
            "longDescription": "This resource shall be used to represent resources that represent the user role for the user account."
        }
    },
    "copyright": "Copyright 2014-2016 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright"
}