GET – Role properties

Use the GET method to retrieve properties in Role resource for Redfish service.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/AccountService/Roles/{Administrator,Operator,ReadOnly and $RoleId}

Request body

None

Response body

Field		Type	Description
Name		String	Any of “Administrator, Operator, ReadOnly, and CustomRole{N}”
Id		String	Any of "Administrator”, “Operator”, “ReadOnly”, and “CustomRole{N}"
RoleId		String	Pre-defined roles: “Administrator”, “Operator”, and “ReadOnly”
OemPrivileges		Array	The value of this property is a set of OEM privileges that this role includes. For pre-defined roles, this property shall be readOnly. The values can be "Supervisor", "ReadOnly", "UserAccountManagement", "RemoteConsoleAccess", "RemoteConsoleAndVirtualMediaAccess", "RemoteServerPowerRestartAccess", "AbilityClearEventLogs", "AdapterConfiguration_Basic", "AdapterConfiguration_NetworkingAndSecurity", "AdapterConfiguration_Advanced"
	OemPrivileges[N]	String	The OEM privilege string. This value can depend on user selection. Refer to OemPrivileges@Redfish.AllowableValues.
OemPrivileges@Redfish.AllowableValues		Array	The OEM privileges allowable for UPDATE opeation. This property is displayed in custom roles and hidden for Administrator, Operator and ReadOnly.
	OemPrivileges@Redfish.AllowableValues[N]	String	The values are： “UserAccountManagement”, “RemoteConsoleAccess”, “RemoteConsoleAndVirtualMediaAccess”, “RemoteServerPowerRestartAccess”, “AbilityClearEventLogs”, “Configuration_Basic”, “Configuration_NetworkingAndSecurity”, “Configuration_Advanced”, “Configuration_UEFISecurity”
IsPredefined		Boolean	This role is pre-defined or not. Note The pre-defined roles are Administrator, Operator, ReadOnly.
AssignedPrivileges		Array	The standard defined privileges for this role.
Description		String	This resource is used to represent a user role for the user account for a Redfish implementation.

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON responses are returned:

Resource /AccountService/Roles/Administrator:

{
    "Id": "Administrator",
    "Name": "Administrator",
    "OemPrivileges": [
        "Supervisor"
    ],
    "@odata.id": "/redfish/v1/AccountService/Roles/Administrator",
    "@odata.etag": "\"3b82a78633e02965953\"",
    "AssignedPrivileges": [
        "Login",
        "ConfigureManager",
        "ConfigureUsers",
        "ConfigureSelf",
        "ConfigureComponents"
    ],
    "RoleId": "Administrator",
    "IsPredefined": true,
    "Description": "This resource is used to represent a user role for the user account for a Redfish implementation.",
    "@odata.context": "/redfish/v1/$metadata#Role.Role",
    "@odata.type": "#Role.v1_3_1.Role"
}

Resource /AccountService/Roles/Operator:

{
    "OemPrivileges": [
        "RemoteServerPowerRestartAccess",
        "AbilityClearEventLogs",
        "Configuration_Basic",
        "Configuration_NetworkingAndSecurity",
        "Configuration_Advanced"
    ],
    "Id": "Operator",
    "Name": "Operator",
    "@odata.type": "#Role.v1_3_1.Role",
    "@odata.id": "/redfish/v1/AccountService/Roles/Operator",
    "@odata.etag": "\"43fc90854f7728ab334\"",
    "@odata.context": "/redfish/v1/$metadata#Role.Role",
    "Description": "This resource is used to represent a user role for the user account for a Redfish implementation.",
    "RoleId": "Operator",
    "AssignedPrivileges": [
        "Login",
        "ConfigureSelf",
        "ConfigureComponents"
    ],
    "IsPredefined": true
}

Resource /AccountService/Roles/ReadOnly:

{
    "RoleId": "ReadOnly",
    "AssignedPrivileges": [
        "Login",
        "ConfigureSelf"
    ],
    "Id": "ReadOnly",
    "Name": "ReadOnly",
    "@odata.type": "#Role.v1_3_1.Role",
    "@odata.id": "/redfish/v1/AccountService/Roles/ReadOnly",
    "@odata.etag": "\"347a35f336d526655a8\"",
    "@odata.context": "/redfish/v1/$metadata#Role.Role",
    "Description": "This resource is used to represent a user role for the user account for a Redfish implementation.",
    "OemPrivileges": [
        "ReadOnly"
    ],
    "IsPredefined": true
}

Resource /AccountService/Roles/CustomRole12:

{
    "AssignedPrivileges": [
        "Login"
    ],
    "Id": "CustomRole12",
    "RoleId": "CustomRole12",
    "@odata.type": "#Role.v1_3_1.Role",
    "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole12",
    "@odata.etag": "\"5b5db60befdb25abd48\"",
    "@odata.context": "/redfish/v1/$metadata#Role.Role",
    "IsPredefined": false,
    "Name": "CustomRole12",
    "Description": "This resource is used to represent a user role for the user account for a Redfish implementation.",
    "OemPrivileges": [
        "UserAccountManagement"
    ],
    "OemPrivileges@Redfish.AllowableValues": [
        "UserAccountManagement",
        "RemoteConsoleAccess",
        "RemoteConsoleAndVirtualMediaAccess",
        "RemoteServerPowerRestartAccess",
        "AbilityClearEventLogs",
        "Configuration_Basic",
        "Configuration_NetworkingAndSecurity",
        "Configuration_Advanced",
        "Configuration_UEFISecurity"
    ]
}

Give documentation feedback

GET – Role properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example