认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。

名称	位置	类型	必填	说明	示例
`Authorization`	header	string	是	应用 API Key，使用 Bearer 方式传递。	`Bearer qwk_***`
`X-Request-Id`	header	string	否	可选的调用追踪标识；未传入时由服务端生成。	`req-20260831-001`

请求参数

名称	位置	类型	必填	说明	示例
`Idempotency-Key`	header	`string`	必填	`-`	`"<string>"`
`description`	body	`string`	否	`-`	`"<string>"`
`member_ids`	body	`array \| null`	必填	`-`	`["<string>"]`
`name`	body	`string`	必填	`-`	`"<string>"`
`permissions`	body	`array \| null`	必填	`-`	`["<string>"]`
`scopes`	body	`array \| null`	必填	`-`	`[{"include_descendants":false,"subject_id":"<string>","subject_type":"<string>"}]`

请求示例

cURL

curl --request POST \
  --url '<BASE_URL>/api/openapi/v1/admin-roles' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Idempotency-Key: <UNIQUE_REQUEST_ID>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "member_ids": [
    "<string>"
  ],
  "name": "<string>",
  "permissions": [
    "<string>"
  ],
  "scopes": [
    {
      "include_descendants": false,
      "subject_id": "<string>",
      "subject_type": "<string>"
    }
  ]
}'

响应

201 Created

名称	类型	必填	说明	示例
`created_at`	`string · date-time`	是	`-`	`"2026-08-27T10:00:00Z"`
`description`	`string`	是	`-`	`"<string>"`
`id`	`string`	是	`-`	`"<string>"`
`member_ids`	`array \| null`	是	`-`	`["<string>"]`
`name`	`string`	是	`-`	`"<string>"`
`permissions`	`array \| null`	是	`-`	`["<string>"]`
`scopes`	`array \| null`	是	`-`	`[{"include_descendants":false,"subject_id":"<string>","subject_type":"<string>"}]`
`system`	`boolean`	是	`-`	`false`
`updated_at`	`string · date-time`	是	`-`	`"2026-08-27T10:00:00Z"`

响应示例

{
  "created_at": "2026-08-27T10:00:00Z",
  "description": "<string>",
  "id": "<string>",
  "member_ids": [
    "<string>"
  ],
  "name": "<string>",
  "permissions": [
    "<string>"
  ],
  "scopes": [
    {
      "include_descendants": false,
      "subject_id": "<string>",
      "subject_type": "<string>"
    }
  ],
  "system": false,
  "updated_at": "2026-08-27T10:00:00Z"
}

default Flat business error

名称	类型	必填	说明	示例
`code`	`string`	否	Stable business error code	`"<string>"`
`detail`	`string`	是	Human-readable error description	`"<string>"`
`details`	`OpenapiErrorDetails`	否	`-`	`{"field":"<string>","reason":"<string>","suggestion":"<string>"}`
`details.field`	`string`	否	Request field that failed validation	`"<string>"`
`details.reason`	`string`	否	Stable validation failure reason	`"<string>"`
`details.suggestion`	`string`	否	Suggested normalized value	`"<string>"`
`error`	`string`	是	Stable HTTP error type	`"<string>"`

响应示例

{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}