中文 ← MyDocs

Members

Create Workspace Member

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

Create Workspace Member

Path Parameters

  • workspace_id: string

    ID of the Workspace.

Body Parameters

  • user_id: string

    ID of the User.

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

    Role of the new Workspace Member. Cannot be "workspace_billing".

    • "workspace_user"

    • "workspace_developer"

    • "workspace_restricted_developer"

    • "workspace_admin"

Returns

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

    • type: "workspace_member"

      Object type.

      For Workspace Members, this is always "workspace_member".

      • "workspace_member"

    • user_id: string

      ID of the User.

    • workspace_id: string

      ID of the Workspace.

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

      Role of the Workspace Member.

      • "workspace_user"

      • "workspace_developer"

      • "workspace_restricted_developer"

      • "workspace_admin"

      • "workspace_billing"

Example

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"
        }'

Response

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

Get Workspace Member

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

Get Workspace Member

Path Parameters

  • workspace_id: string

    ID of the Workspace.

  • user_id: string

    ID of the User.

Returns

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

    • type: "workspace_member"

      Object type.

      For Workspace Members, this is always "workspace_member".

      • "workspace_member"

    • user_id: string

      ID of the User.

    • workspace_id: string

      ID of the Workspace.

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

      Role of the Workspace Member.

      • "workspace_user"

      • "workspace_developer"

      • "workspace_restricted_developer"

      • "workspace_admin"

      • "workspace_billing"

Example

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"

Response

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

List Workspace Members

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

List Workspace Members

Path Parameters

  • workspace_id: string

    ID of the Workspace.

Query Parameters

  • after_id: optional string

    ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

  • before_id: optional string

    ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

  • limit: optional number

    Number of items to return per page.

    Defaults to 20. Ranges from 1 to 1000.

Returns

  • data: array of WorkspaceMember

    • type: "workspace_member"

      Object type.

      For Workspace Members, this is always "workspace_member".

      • "workspace_member"

    • user_id: string

      ID of the User.

    • workspace_id: string

      ID of the Workspace.

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

      Role of the Workspace Member.

      • "workspace_user"

      • "workspace_developer"

      • "workspace_restricted_developer"

      • "workspace_admin"

      • "workspace_billing"

  • first_id: string

    First ID in the data list. Can be used as the before_id for the previous page.

  • has_more: boolean

    Indicates if there are more results in the requested page direction.

  • last_id: string

    Last ID in the data list. Can be used as the after_id for the next page.

Example

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"

Response

{
  "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"
}

Update Workspace Member

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

Update Workspace Member

Path Parameters

  • workspace_id: string

    ID of the Workspace.

  • user_id: string

    ID of the User.

Body Parameters

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

    New workspace role for the User.

    • "workspace_user"

    • "workspace_developer"

    • "workspace_restricted_developer"

    • "workspace_admin"

    • "workspace_billing"

Returns

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

    • type: "workspace_member"

      Object type.

      For Workspace Members, this is always "workspace_member".

      • "workspace_member"

    • user_id: string

      ID of the User.

    • workspace_id: string

      ID of the Workspace.

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

      Role of the Workspace Member.

      • "workspace_user"

      • "workspace_developer"

      • "workspace_restricted_developer"

      • "workspace_admin"

      • "workspace_billing"

Example

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"
        }'

Response

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

Delete Workspace Member

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

Delete Workspace Member

Path Parameters

  • workspace_id: string

    ID of the Workspace.

  • user_id: string

    ID of the User.

Returns

  • type: "workspace_member_deleted"

    Deleted object type.

    For Workspace Members, this is always "workspace_member_deleted".

    • "workspace_member_deleted"

  • user_id: string

    ID of the User.

  • workspace_id: string

    ID of the Workspace.

Example

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"

Response

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

Domain Types

Workspace Member

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

    • type: "workspace_member"

      Object type.

      For Workspace Members, this is always "workspace_member".

      • "workspace_member"

    • user_id: string

      ID of the User.

    • workspace_id: string

      ID of the Workspace.

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

      Role of the Workspace Member.

      • "workspace_user"

      • "workspace_developer"

      • "workspace_restricted_developer"

      • "workspace_admin"

      • "workspace_billing"

Member Delete Response

  • MemberDeleteResponse object { type, user_id, workspace_id }

    • type: "workspace_member_deleted"

      Deleted object type.

      For Workspace Members, this is always "workspace_member_deleted".

      • "workspace_member_deleted"

    • user_id: string

      ID of the User.

    • workspace_id: string

      ID of the Workspace.