SPB Git

Repository Public

update.md 1.8 KB


# title: Update User url: https://platform.claude.com/docs/en/api/beta/organization/users/update

# Update User

POST /v1/organizations/users/{user_id}

Update a member's organization role.

# Path parameters

  • user_id: string

    ID of the User.

# Body parameters

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

    New role for the User.

    The accepted values depend on the organization type. Console and API organizations accept user, developer, billing, and claude_code_user; admin cannot be assigned through the API. Claude Enterprise organizations accept user and managed.

    • "billing"

    • "claude_code_user"

    • "developer"

    • "managed"

    • "user"

# Returns

  • BetaOrganizationUser object

    • type: "user"

      Object type.

      For Users, this is always "user".

      default: user

    • id: string

      ID of the User.

    • added_at: string

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

      format: date-time

    • email: string

      Email of the User.

    • name: string

      Name of the User.

    • role: BetaOrganizationRole

      Organization role of the User.

      • "admin"

      • "billing"

      • "claude_code_user"

      • "developer"

      • "managed"

      • "membership_admin"

      • "owner"

      • "primary_owner"

      • "user"

# Example

bash
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_API_KEY" \
    -d '{
          "role": "user"
        }'

# Response (200)

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

Theme