跳转到正文
皓量云擎文档
接口参考角色与权限

更新自定义角色权限

PUT /api/admin/v1/roles/{role_id},updatePlatformRole 的请求参数和响应结构。

PUT /api/admin/v1/roles/{role_id}

项目内容
操作标识updatePlatformRole
认证登录会话 Cookie

PostgreSQL 持久化;角色、租户状态与成员资格在每次请求的数据库事务中重新校验。未配置 DATABASE_URL 时返回 503。

会话写请求需要合法的 Origin 和与当前 Cookie 绑定的 X-CSRF-Token。登录成功后应重新获取 CSRF 令牌。具体权限由目标资源归属和当前授权决定,见认证约定。

请求参数

名称位置必填类型说明与约束
role_idpath是string格式:uuid
X-CSRF-Tokenheader是string先 GET /api/auth/v1/csrf 获取,与当前 Cookie 会话绑定;写请求同时要求 Origin 等于配置的 PUBLIC_ORIGIN。;最短 1

请求体

请求体必填。

内容类型:application/json。

字段类型必填说明与约束
codestring否正则:^[a-z][a-z0-9_-]{1,47}$
namestring是最短 1;最长 128
descriptionstring是最长 500
permissionsstring[]是—
完整请求结构(含引用定义)
{
  "$ref": "#/$defs/IAMRoleInput",
  "$defs": {
    "IAMRoleInput": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string",
          "pattern": "^[a-z][a-z0-9_-]{1,47}$"
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "description": {
          "type": "string",
          "maxLength": 500
        },
        "permissions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "name",
        "description",
        "permissions"
      ]
    }
  }
}

响应

HTTP 状态含义
200成功
400参数错误
401登录无效或已撤销
403权限、范围或 CSRF 校验失败
404记录不存在
409引用或唯一性冲突
429请求过于频繁
503数据库未配置或不可用
200 · application/json 响应结构
字段类型必填说明与约束
dataIAMRole是—
request_idstring是—
{
  "$ref": "#/$defs/IAMRoleResponse",
  "$defs": {
    "IAMRoleResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "data": {
          "$ref": "#/$defs/IAMRole"
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "data",
        "request_id"
      ]
    },
    "IAMRole": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid"
        },
        "code": {
          "type": "string",
          "pattern": "^[a-z][a-z0-9_-]{1,47}$"
        },
        "name": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128
        },
        "scope": {
          "type": "string",
          "enum": [
            "platform",
            "tenant"
          ]
        },
        "tenant_id": {
          "type": "string",
          "format": "uuid",
          "nullable": true
        },
        "builtin": {
          "type": "boolean"
        },
        "description": {
          "type": "string",
          "maxLength": 500
        },
        "permissions": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "id",
        "code",
        "name",
        "scope",
        "tenant_id",
        "builtin",
        "description",
        "permissions"
      ]
    }
  }
}
400 / 401 / 403 / 404 / 409 / 429 / 503 · application/json 响应结构
{
  "$ref": "#/$defs/ErrorResponse",
  "$defs": {
    "ErrorResponse": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "error": {
          "$ref": "#/$defs/ErrorDetail"
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "error",
        "request_id"
      ]
    },
    "ErrorDetail": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string",
          "enum": [
            "NOT_IMPLEMENTED",
            "NOT_FOUND",
            "AUTH_REQUIRED",
            "FORBIDDEN",
            "VALIDATION_FAILED",
            "CONFLICT",
            "SERVICE_UNAVAILABLE",
            "INTERNAL_ERROR",
            "RATE_LIMITED"
          ]
        },
        "message": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        },
        "fields": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "required": [
        "code",
        "message",
        "retryable"
      ]
    }
  }
}

响应中的 request_id 用于排查请求;异步操作以任务最终状态为准。参阅调用约定、异步任务和错误处理。

本页由版本化 OpenAPI 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。

本页目录