GET – Role Instance
This resource shall be used to represent resources that represent the user role for the user account.
Request
GET https://{{ip}}/redfish/v1/AccountService/Roles/{{role_instance}}
Content-Type: application/json
Response
The response is a JSON object that contains the following parameters:
Name | Type | Read only | Description | |
| (OData Attributes) | Refer to OData Support | |||
Id(M) | String | True | Refer to Resource Type Definitions | |
Name(M) | String | True | ||
Description | String | True | ||
IsPredefined | Boolean | True | This property is used to indicate if the Role is one of the Redfish Predefined Roles vs a Custom role. | |
AssignedPrivileges | Array | False | 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. | |
Enum | Description | |||
Login | Able to log into the service and read resources. | |||
ConfigureManager | Able to configure Manager resources. | |||
ConfigureUsers | Able to configure Users and their Accounts. | |||
ConfigureSelf | Able to change the password for the current user Account. | |||
ConfigureComponents | Able to configure components managed by this service. | |||
OemPrivileges | Array | False | 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. | |
Enum | Description | |||
| ConfigureHostInterface | Able to configure HostInterface resources. Note Only | |||
Actions | Object | True | This object will contain the actions for this resource under Oem property if any. | |
RoleId | String | True | This property shall contain the string name of the Role. This property shall contain the same value as the Id property. | |