Skip to main content

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

FieldTypeDescription

Name

StringAny of “Administrator, Operator, ReadOnly, and CustomRole{N}”

Id

StringAny of "Administrator”, “Operator”, “ReadOnly”, and “CustomRole{N}"

RoleId

StringPre-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]

StringThe OEM privilege string. This value can depend on user selection. Refer to OemPrivileges@Redfish.AllowableValues.

OemPrivileges@Redfish.AllowableValues

ArrayThe 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

BooleanThis role is pre-defined or not.
Note
The pre-defined roles are Administrator, Operator, ReadOnly.

AssignedPrivileges

ArrayThe standard defined privileges for this role.

Description

StringThis resource is used to represent a user role for the user account for a Redfish implementation.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

The following example JSON responses are returned:

Resource /AccountService/Roles/Administrator:

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

Resource /AccountService/Roles/Operator:

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

Resource /AccountService/Roles/ReadOnly:

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

Resource /AccountService/Roles/CustomRole12:

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