Claude Platform Docs

Criar convite

beta.organization.invites.create(**kwargs) -> BetaOrganizationInvite
POST/v1/organizations/invites

Convide um usuário para ingressar na organização por e-mail.

Em planos que obtêm membros de um conjunto finito de assentos adquiridos, o convite consome automaticamente um assento do nível mais baixo com disponibilidade; não há parâmetro de nível de assento. Quando não há assento livre, a solicitação falha com um erro 400 em vez de adquirir um assento.

Parameters
email: String

Email of the User.

formatemail
role: :billing | :claude_code_user | :developer | 2 more

Role for the invited 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; inviting with the managed role requires the write:rbac_groups scope in addition to write:members.

One of the following:
:billing
:claude_code_user
:developer
:managed
:user
rbac_group_ids: Array[String]

RBAC group IDs to assign to the User when the Invite is accepted. A non-empty array is accepted only for a Claude Enterprise organization with RBAC groups, and requires the key to carry the write:rbac_groups scope.

maxItems100
Returns
class BetaOrganizationInvite { type: :invite, id, accepted_at, 6 more }
Criar convite
require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

beta_organization_invite = anthropic.beta.organization.invites.create(email: "user@emaildomain.com", role: :user)

puts(beta_organization_invite)
Returns Examples
Response 200
{
  "id": "invite_015gWxCN9Hfg2QhZwTK7Mdeu",
  "accepted_at": "2019-12-27T18:11:19.117Z",
  "email": "user@emaildomain.com",
  "expires_at": "2024-11-20T23:58:27.427722Z",
  "invited_at": "2024-10-30T23:58:27.427722Z",
  "rbac_group_ids": [
    "string"
  ],
  "role": "admin",
  "status": "pending",
  "type": "invite"
}