开发者文档

设置成员角色

PATCH/api/orgs/:orgId/members/:userId

权限与前置条件

工作区所有者;目标成员必须有效,受交接规则约束。

此接口仅支持浏览器登录,不接受 API Key。Cookie 写入仍需允许来源的 Origin 和 X-Requested-With: suren360。不能同时携带 Cookie 与 API Key。所有路径参数须使用真实 ID。

请求参数

orgId · 路径参数 · 必填字符串

userId · 路径参数 · 必填字符串

JSON 请求体

字段类型必填约束
rolestring是{"enum":["admin","member"]}
查看完整请求 JSON Schema
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "member"
      ]
    }
  },
  "required": [
    "role"
  ],
  "additionalProperties": false
}

调用示例

先通过浏览器统一登录,使用受控环境中的已有会话。 请替换部署地址与示例字段,不要将凭证粘贴到聊天或日志中。

cURL · 示例占位值需替换
curl --request PATCH \
  'https://YOUR_DEPLOYMENT_HOST/api/orgs/YOUR_orgId/members/YOUR_userId' \
  --cookie "$SUREN360_COOKIE" \
  --header 'Origin: https://YOUR_DEPLOYMENT_HOST' \
  --header 'X-Requested-With: suren360' \
  --header 'Content-Type: application/json' \
  --data '{
  "role": "admin"
}'

响应结构

成功返回 HTTP 200 的 JSON 对象。下方为响应结构定义,不是虚构的业务数据。

字段类型必填约束
memberobject是{"required":["id","userId","nickname","accountId","role","groups","responsibleCount","joinedAt","status"],"additionalProperties":false}
查看完整响应 JSON Schema
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "member": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "userId": {
          "type": "string"
        },
        "nickname": {
          "type": "string"
        },
        "accountId": {
          "type": "string"
        },
        "role": {
          "type": "string",
          "enum": [
            "owner",
            "admin",
            "member"
          ]
        },
        "groups": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "responsibleCount": {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              "role": {
                "type": "string",
                "enum": [
                  "leader",
                  "member"
                ]
              }
            },
            "required": [
              "id",
              "name",
              "responsibleCount",
              "role"
            ],
            "additionalProperties": false
          }
        },
        "responsibleCount": {
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "joinedAt": {
          "type": "string",
          "format": "date-time",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "suspended"
          ]
        }
      },
      "required": [
        "id",
        "userId",
        "nickname",
        "accountId",
        "role",
        "groups",
        "responsibleCount",
        "joinedAt",
        "status"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "member"
  ],
  "additionalProperties": false
}
查看错误码与重试规则