中文 ← MyDocs

Users

Get User

get /v1/organizations/users/{user_id}

Get User

Path Parameters

  • user_id: string

    ID of the User.

Returns

  • User object { id, added_at, email, 3 more }

    • id: string

      ID of the User.

    • added_at: string

      RFC 3339 datetime string indicating when the User joined the Organization.

    • email: string

      Email of the User.

    • name: string

      Name of the User.

    • role: "user" or "developer" or "billing" or 2 more

      Organization role of the User.

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • type: "user"

      Object type.

      For Users, this is always "user".

      • "user"

Example

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

Response

{
  "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "added_at": "2024-10-30T23:58:27.427722Z",
  "email": "user@emaildomain.com",
  "name": "Jane Doe",
  "role": "user",
  "type": "user"
}

List Users

get /v1/organizations/users

List Users

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.

  • email: optional string

    Filter by user email.

  • limit: optional number

    Number of items to return per page.

    Defaults to 20. Ranges from 1 to 1000.

Returns

  • data: array of User

    • id: string

      ID of the User.

    • added_at: string

      RFC 3339 datetime string indicating when the User joined the Organization.

    • email: string

      Email of the User.

    • name: string

      Name of the User.

    • role: "user" or "developer" or "billing" or 2 more

      Organization role of the User.

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • type: "user"

      Object type.

      For Users, this is always "user".

      • "user"

  • 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/users \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

Response

{
  "data": [
    {
      "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
      "added_at": "2024-10-30T23:58:27.427722Z",
      "email": "user@emaildomain.com",
      "name": "Jane Doe",
      "role": "user",
      "type": "user"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

Update User

post /v1/organizations/users/{user_id}

Update User

Path Parameters

  • user_id: string

    ID of the User.

Body Parameters

  • role: "user" or "developer" or "billing" or "claude_code_user"

    New role for the User. Cannot be "admin".

    • "user"

    • "developer"

    • "billing"

    • "claude_code_user"

Returns

  • User object { id, added_at, email, 3 more }

    • id: string

      ID of the User.

    • added_at: string

      RFC 3339 datetime string indicating when the User joined the Organization.

    • email: string

      Email of the User.

    • name: string

      Name of the User.

    • role: "user" or "developer" or "billing" or 2 more

      Organization role of the User.

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • type: "user"

      Object type.

      For Users, this is always "user".

      • "user"

Example

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

Response

{
  "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "added_at": "2024-10-30T23:58:27.427722Z",
  "email": "user@emaildomain.com",
  "name": "Jane Doe",
  "role": "user",
  "type": "user"
}

Remove User

delete /v1/organizations/users/{user_id}

Remove User

Path Parameters

  • user_id: string

    ID of the User.

Returns

  • id: string

    ID of the User.

  • type: "user_deleted"

    Deleted object type.

    For Users, this is always "user_deleted".

    • "user_deleted"

Example

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

Response

{
  "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
  "type": "user_deleted"
}

Domain Types

User

  • User object { id, added_at, email, 3 more }

    • id: string

      ID of the User.

    • added_at: string

      RFC 3339 datetime string indicating when the User joined the Organization.

    • email: string

      Email of the User.

    • name: string

      Name of the User.

    • role: "user" or "developer" or "billing" or 2 more

      Organization role of the User.

      • "user"

      • "developer"

      • "billing"

      • "admin"

      • "claude_code_user"

    • type: "user"

      Object type.

      For Users, this is always "user".

      • "user"

User Delete Response

  • UserDeleteResponse object { id, type }

    • id: string

      ID of the User.

    • type: "user_deleted"

      Deleted object type.

      For Users, this is always "user_deleted".

      • "user_deleted"