Claude Platform Docs

Créer une invitation

$client->organization->invites->create(string email, Role role, ?list<string> rbacGroupIDs): OrganizationInvite
POST/v1/organizations/invites

Invitez un utilisateur à rejoindre l'organisation par e-mail.

Sur les forfaits qui attribuent les membres à partir d'un nombre fini de sièges achetés, l'invitation consomme automatiquement un siège du niveau le plus bas disposant de places disponibles ; il n'existe aucun paramètre de niveau de siège. Lorsqu'aucun siège n'est libre, la requête échoue avec une erreur 400 au lieu d'acheter un siège.

Parameters
email: string

Email of the User.

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.

rbacGroupIDs?: optional list<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.

Returns
class OrganizationInvite { $type = 'invite'; $id; $acceptedAt; /* 6 more */ }
"invite" type

Object type.

For Invites, this is always "invite".

string id

ID of the Invite.

?\Datetime acceptedAt

RFC 3339 datetime string indicating when the Invite was accepted, or null.

string email

Email of the User being invited.

\Datetime expiresAt

RFC 3339 datetime string indicating when the Invite expires.

\Datetime invitedAt

RFC 3339 datetime string indicating when the Invite was created.

list<string> rbacGroupIDs

RBAC group IDs recorded on the Invite (Claude Enterprise organizations), to be assigned to the User when the Invite is accepted. [] when none.

OrganizationRole role

Organization role of the User.

Status status

Status of the Invite.

Créer une invitation
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Anthropic\Client;

$client = new Client(apiKey: 'my-anthropic-api-key');

$organizationInvite = $client->organization->invites->create(
  email: 'user@emaildomain.com', role: 'user', rbacGroupIDs: ['string']
);

var_dump($organizationInvite);
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"
}