成员

创建工作区成员

post /v1/organizations/workspaces/{workspace_id}/members

创建工作区成员

路径参数

• workspace_id: string

  工作区的 ID。

请求体参数

• user_id: string

  用户的 ID。

• workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or "workspace_admin"

  新工作区成员的角色。不能为 "workspace_billing"。

  • "workspace_user"

  • "workspace_developer"

  • "workspace_restricted_developer"

  • "workspace_admin"

返回值

• WorkspaceMember object { type, user_id, workspace_id, workspace_role }

  • type: "workspace_member"

    对象类型。

    对于工作区成员，始终为 "workspace_member"。

    • "workspace_member"

  • user_id: string

    用户的 ID。

  • workspace_id: string

    工作区的 ID。

  • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

    工作区成员的角色。

    • "workspace_user"

    • "workspace_developer"

    • "workspace_restricted_developer"

    • "workspace_admin"

    • "workspace_billing"

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{
          "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
          "workspace_role": "workspace_user"
        }'

响应

{
  "type": "workspace_member",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "workspace_role": "workspace_user"
}

获取工作区成员

get /v1/organizations/workspaces/{workspace_id}/members/{user_id}

获取工作区成员

路径参数

• workspace_id: string

  工作区的 ID。

• user_id: string

  用户的 ID。

返回值

• WorkspaceMember object { type, user_id, workspace_id, workspace_role }

  • type: "workspace_member"

    对象类型。

    对于工作区成员，始终为 "workspace_member"。

    • "workspace_member"

  • user_id: string

    用户的 ID。

  • workspace_id: string

    工作区的 ID。

  • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

    工作区成员的角色。

    • "workspace_user"

    • "workspace_developer"

    • "workspace_restricted_developer"

    • "workspace_admin"

    • "workspace_billing"

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "type": "workspace_member",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "workspace_role": "workspace_user"
}

列出工作区成员

get /v1/organizations/workspaces/{workspace_id}/members

列出工作区成员

路径参数

• workspace_id: string

  工作区的 ID。

查询参数

• after_id: optional string

  用作分页游标的对象 ID。提供后，返回该对象之后的结果页。

• before_id: optional string

  用作分页游标的对象 ID。提供后，返回该对象之前的结果页。

• limit: optional number

  每页返回的项目数。

  默认为 20。范围为 1 到 1000。

返回值

• data: array of WorkspaceMember

  • type: "workspace_member"

    对象类型。

    对于工作区成员，始终为 "workspace_member"。

    • "workspace_member"

  • user_id: string

    用户的 ID。

  • workspace_id: string

    工作区的 ID。

  • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

    工作区成员的角色。

    • "workspace_user"

    • "workspace_developer"

    • "workspace_restricted_developer"

    • "workspace_admin"

    • "workspace_billing"

• first_id: string

  data 列表中的第一个 ID。可用作上一页的 before_id。

• has_more: boolean

  指示在请求的页面方向上是否还有更多结果。

• last_id: string

  data 列表中的最后一个 ID。可用作下一页的 after_id。

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "data": [
    {
      "type": "workspace_member",
      "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
      "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
      "workspace_role": "workspace_user"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

更新工作区成员

post /v1/organizations/workspaces/{workspace_id}/members/{user_id}

更新工作区成员

路径参数

• workspace_id: string

  工作区的 ID。

• user_id: string

  用户的 ID。

请求体参数

• workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

  用户的新工作区角色。

  • "workspace_user"

  • "workspace_developer"

  • "workspace_restricted_developer"

  • "workspace_admin"

  • "workspace_billing"

返回值

• WorkspaceMember object { type, user_id, workspace_id, workspace_role }

  • type: "workspace_member"

    对象类型。

    对于工作区成员，始终为 "workspace_member"。

    • "workspace_member"

  • user_id: string

    用户的 ID。

  • workspace_id: string

    工作区的 ID。

  • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

    工作区成员的角色。

    • "workspace_user"

    • "workspace_developer"

    • "workspace_restricted_developer"

    • "workspace_admin"

    • "workspace_billing"

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" \
    -d '{
          "workspace_role": "workspace_user"
        }'

响应

{
  "type": "workspace_member",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "workspace_role": "workspace_user"
}

删除工作区成员

delete /v1/organizations/workspaces/{workspace_id}/members/{user_id}

删除工作区成员

路径参数

• workspace_id: string

  工作区的 ID。

• user_id: string

  用户的 ID。

返回值

• type: "workspace_member_deleted"

  已删除对象的类型。

  对于工作区成员，始终为 "workspace_member_deleted"。

  • "workspace_member_deleted"

• user_id: string

  用户的 ID。

• workspace_id: string

  工作区的 ID。

示例

curl https://api.anthropic.com/v1/organizations/workspaces/$WORKSPACE_ID/members/$USER_ID \
    -X DELETE \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

响应

{
  "type": "workspace_member_deleted",
  "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}

领域类型

工作区成员

• WorkspaceMember object { type, user_id, workspace_id, workspace_role }

  • type: "workspace_member"

    对象类型。

    对于工作区成员，始终为 "workspace_member"。

    • "workspace_member"

  • user_id: string

    用户的 ID。

  • workspace_id: string

    工作区的 ID。

  • workspace_role: "workspace_user" or "workspace_developer" or "workspace_restricted_developer" or 2 more

    工作区成员的角色。

    • "workspace_user"

    • "workspace_developer"

    • "workspace_restricted_developer"

    • "workspace_admin"

    • "workspace_billing"

成员删除响应

• MemberDeleteResponse object { type, user_id, workspace_id }

  • type: "workspace_member_deleted"

    已删除对象的类型。

    对于工作区成员，始终为 "workspace_member_deleted"。

    • "workspace_member_deleted"

  • user_id: string

    用户的 ID。

  • workspace_id: string

    工作区的 ID。