Claude Platform Docs

建立邀請

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

透過電子郵件邀請使用者加入組織。

在從有限的已購買席位池中提取成員的方案中，邀請會自動從有空位的最低層級消耗一個席位；沒有席位層級參數。當沒有空閒席位時，請求會以 400 錯誤失敗，而不會購買席位。

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.

建立邀請
<?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"
}