文档中心
Role
更新时间： 2026/06/26
在Gitcode上查看源码

ResourceDefinition ​

uris ​

  • /redfish/v1/AccountService/Roles/{role_id}

properties ​

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-指定角色资源模型的OData描述信息
@odata.idstringtrue-指定角色资源节点的访问路径
@odata.typestringtrue-指定角色资源类型
Idstringtrue-指定角色资源的ID
RoleIdstringtrue-指定角色资源的ID
Namestringtrue-指定角色资源的名称
IsPredefinedbooleantruetrue,false指定角色是否预定义
AssignedPrivilegesarrayfalseLogin,ConfigureComponents,ConfigureSelf,ConfigureUsersRedfish定义的权限类型：
● Login：登录
● ConfigureComponents：常规登录
● ConfigureSelf：配置自身
● ConfigureUsers：用户配置
OemPrivilegesarrayfalseOemKvm,OemVmm,OemSecurityMgmt,OemPowerControl,OemDiagnosis服务器自定义的权限类型：
● OemKvm：远程控制
● OemVmm：远程媒体
● OemSecurityMgmt：安全配置
● OemPowerControl：电源控制
● OemDiagnosis：调试诊断

supported_methods ​

  • GET
  • PATCH
  • DELETE

HTTP methods ​

GET ​

命令功能

查询指定角色信息

命令格式

URL: https://device_ip/redfish/v1/AccountService/Roles/role_id

请求头:


X-Auth-Token: 123456789***********************

请求消息体: 无

参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
role_id角色ID可通过角色集合资源获得
auth_value执行该GET请求时，必须在"Headers"中携带"X-Auth-Token"值用于鉴权可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

无

使用实例

请求样例：

http
GET https://device_ip/redfish/v1/AccountService/Roles/Administrator

请求头：


X-Auth-Token: 123456789***********************

请求消息体：无

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#Role.Role",
  "@odata.id": "/redfish/v1/AccountService/Roles/Administrator",
  "@odata.type": "#Role.v1_3_3.Role",
  "Id": "Administrator",
  "RoleId": "Administrator",
  "Name": "User Role",
  "IsPredefined": true,
  "AssignedPrivileges": [
    "Login",
    "ConfigureUsers",
    "ConfigureSelf",
    "ConfigureComponents"
  ],
  "OemPrivileges": [
    "OemKvm",
    "OemVmm",
    "OemSecurityMgmt",
    "OemPowerControl",
    "OemDiagnosis"
  ]
}

响应码：200

PATCH ​

命令功能

修改自定义角色权限

命令格式

URL: https://device_ip/redfish/v1/AccountService/Roles/role_id

请求头:


X-Auth-Token: 123456789***********************
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json
{
  "AssignedPrivileges": [
    Privilegelist1
  ],
  "OemPrivileges": [
    Privilegelist2
  ]
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
role_id角色ID可修改属性的角色类型包括：CustomRole1~CustomRole16
ifmatch_value请求消息的匹配参数可通过对指定权限资源发起GET操作，从响应头中获取（对应于"ETag"参数）
Privilegelist1Redfish定义的权限● "Login"
● "ConfigureComponents"
● "ConfigureSelf"
● ConfigureUsers（只有管理员用户才有ConfigureUsers权限，这个是不能修改的）
可同时配置多种权限，并以","分割。其中，"Login"为必配参数
Privilegelist2服务器定义的权限● "OemKvm"
● "OemVmm"
● "OemSecurityMgmt"
● "OemPowerControl"
● "OemDiagnosis"
可以为空，也可同时配置多种权限，并以","分割

使用指南

无

使用实例

请求样例：

http
PATCH https://device_ip/redfish/v1/AccountService/Roles/CustomRole1

请求头：


X-Auth-Token: 123456789***********************
Content-Type: application/json
If-Match：W/"3d607e36"

请求消息体：

json
{
  "AssignedPrivileges": [
    "Login"
  ],
  "OemPrivileges": [
    "OemKvm",
    "OemVmm"
  ]
}

响应样例：

json
{
  "@odata.context": "/redfish/v1/$metadata#Role.Role",
  "@odata.id": "/redfish/v1/AccountService/Roles/CustomRole1",
  "@odata.type": "#Role.v1_0_2.Role",
  "Id": "CustomRole1",
  "Name": "User Role",
  "IsPredefined": false,
  "AssignedPrivileges": [
    "Login"
  ],
  "OemPrivileges": [
    "OemKvm",
    "OemVmm"
  ]
}

响应码：200

DELETE ​

命令功能

删除自定义角色

命令格式

URL: https://device_ip/redfish/v1/AccountService/Roles/role_id

请求头:


X-Auth-Token: 123456789***********************

请求消息体: 无

参数说明

参数参数说明取值
device_ip登录设备的IP地址IPv4或IPv6地址
role_id角色ID可删除的自定义角色Id：CustomRole5~CustomRole16，可通过查询角色集合列表获得
auth_value请求消息的鉴权参数可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

无

使用实例

请求样例：

http
DELETE https://device_ip/redfish/v1/AccountService/Roles/CustomRole5

请求头：


X-Auth-Token: 123456789***********************

请求消息体：无

响应样例：

json
{
  "error": {
    "code": "Base.1.0.GeneralError",
    "message": "A general error has occurred. See ExtendedInfo for more information.",
    "@Message.ExtendedInfo": [
      {
        "@odata.type": "#Message.v1_0_0.Message",
        "MessageId": "Base.1.0.Success",
        "RelatedProperties": [],
        "Message": "Successfully Completed Request",
        "MessageArgs": [],
        "Severity": "OK",
        "Resolution": "None"
      }
    ]
  }
}

响应码：200

输出说明

参见 DELETE 通用输出说明