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

String

  • Pre-defined roles: “Administrator”, “Operator”, “ReadOnly”

  • Custom roles: determined by user when a role is created

    .

Id

String

  • Pre-defined roles: “Administrator”, “Operator”, “ReadOnly”

  • Custom roles: determined by user when a role is created

    .

RoleId

String

  • Pre-defined roles: “Administrator”, “Operator”, “ReadOnly”

  • Custom roles: determined by user when a role is created

    .

Description

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

OemPrivileges

Array

Items: string

Item count: 1~11

 

OemPrivileges[N]

String
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

  • Configuration_NetworkingAndSecurity

  • UserAccountManagement

  • RemoteConsoleAccess

  • RemoteConsoleAndVirtualMediaAccess

  • RemoteServerPowerRestartAccess

  • Configuration_Basic

  • AbilityClearEventLogs

  • Configuration_Advanced

  • Configuration_UEFISecurity

OemPrivileges@Redfish.AllowableValues

Array

Items: string

Item count: 9

The OEM privileges allowable for UPDATE operation. 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.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON responses are returned:

Resource /AccountService/Roles/Administrator:

{
    "@odata.context": "/redfish/v1/$metadata#Role.Role",
    "@odata.etag": "\"28A490BB\"",
    "@odata.id": "/redfish/v1/AccountService/Roles/Administrator",
    "@odata.type": "#Role.v1_2_2.Role",
    "AssignedPrivileges": [
        "Login",
        "ConfigureManager",
        "ConfigureUsers",
        "ConfigureSelf",
        "ConfigureComponents"
    ],
    "Description": "This resource is used to represent a user role                     for the user account for a Redfish implementation.",
    "Id": "Administrator",
    "IsPredefined": true,
    "Name": "Administrator",
    "OemPrivileges": [
        "Supervisor"
    ],
    "OemPrivileges@Redfish.AllowableValues": [
        "UserAccountManagement",
        "RemoteConsoleAccess",
        "RemoteConsoleAndVirtualMediaAccess",
        "RemoteServerPowerRestartAccess",
        "AbilityClearEventLogs",
        "Configuration_Basic",
        "Configuration_NetworkingAndSecurity",
        "Configuration_Advanced",
        "Configuration_UEFISecurity"
    ],
    "RoleId": "Administrator"
}

Resource /AccountService/Roles/Operator:

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

Resource /AccountService/Roles/ReadOnly:

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