Skip to main content

GET – Collection for roles

Use the GET method to retrieve properties in role collection for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/AccountService/Roles

Request body​

None

Response body​

FieldTypeDescription

Name

String

“RoleCollection”

Members

Array

Items: links

Item count: 3~32 for non-edge platforms, or 4~32 for edge platforms.

 

Members[N]

Link

Links to user role resource instances.

Description

String

A collection of Role resource instances.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

When the request is successful, a message body similar to the following is returned:

{
    "@odata.context": "/redfish/v1/$metadata#RoleCollection.RoleCollection",
    "Name": "RoleCollection",
    "Description": "A collection of Role resource instances.",
    "@odata.type": "#RoleCollection.RoleCollection",
    "@odata.id": "/redfish/v1/AccountService/Roles",
    "Members": [
        {
            "@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
        },
        {
            "@odata.id": "/redfish/v1/AccountService/Roles/Operator"
        },
        {
            "@odata.id": "/redfish/v1/AccountService/Roles/ReadOnly"
        }
    ],
    "Members@odata.count": 3,
    "@odata.etag": "\"331cec41575a24e480d\""
}