¶ 修改角色
更新时间: 2025-08-20 12:33:28
通过权限分组内角色新旧 code,修改角色,可以选择角色描述等。
¶ 请求参数
| 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 | 
|---|---|---|---|---|---|
| newCode | string | 是 | - | 角色新的权限分组内唯一识别码。 | code2 | 
| code | string | 是 | - | 权限分组内角色的唯一标识符。 | code1 | 
| namespace | string | 否 | default | 所属权限分组的 code。 | default | 
| description | string | 否 | - | 角色描述。 | this is description | 
¶ 示例代码
import { ManagementClient } from 'authing-node-sdk';
// 在 Node.js 中引用:
// const { ManagementClient } = require('authing-node-sdk');
const managementClient = new ManagementClient({
  accessKeyId: 'AUTHING_USERPOOL_ID',
  accessKeySecret: 'AUTHING_USERPOOL_SECRET',
});
(async () => {
  const result = await managementClient.updateRole({
    code: 'code1',
    newCode: 'code2',
    namespace: 'default',
    description: 'this is description',
 });
})();
¶ 请求响应
类型: IsSuccessRespDto
| 名称 | 类型 | 描述 | 
|---|---|---|
| statusCode | number | 业务状态码,可以通过此状态码判断操作是否成功,200 表示成功。 | 
| message | string | 描述信息 | 
| apiCode | number | 细分错误码,可通过此错误码得到具体的错误类型。 | 
| data | IsSuccessDto | 操作是否成功 | 
示例结果:
{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "success": true
  }
}
¶ 数据结构
¶ IsSuccessDto
| 名称 | 类型 | 必填 | 描述 | 
|---|---|---|---|
| success | boolean | 是 | 操作是否成功。 示例值: true |