Claude Platform Docs

Criar convite

OrganizationInvite organization().invites().create(params, requestOptions = RequestOptions.none())
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
InviteCreateParams params
String email

Email of the User.

formatemail
Role role

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.

BILLING("billing")
CLAUDE_CODE_USER("claude_code_user")
DEVELOPER("developer")
MANAGED("managed")
USER("user")
Optional<List<String>> rbacGroupIds

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 OrganizationInvite { type = "invite"; id; acceptedAt; /* 6 more */ }
Criar convite
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.organization.invites.InviteCreateParams;
import com.anthropic.models.organization.invites.OrganizationInvite;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        InviteCreateParams params = InviteCreateParams.builder()
            .email("user@emaildomain.com")
            .role(InviteCreateParams.Role.USER)
            .build();
        OrganizationInvite organizationInvite = client.organization().invites().create(params);
    }
}
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"
}