Claude Platform Docs

Buat Undangan

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

Undang pengguna untuk bergabung dengan organisasi melalui email.

Pada paket yang mengambil anggota dari kumpulan terbatas seat yang dibeli, undangan secara otomatis menggunakan satu seat dari tingkat terendah yang tersedia; tidak ada parameter tingkat seat. Ketika tidak ada seat yang kosong, permintaan gagal dengan kesalahan 400 alih-alih membeli seat.

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.

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.

BetaOrganizationRole role

Organization role of the User.

Status status

Status of the Invite.

Buat Undangan
<?php

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

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

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

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