Claude Platform Docs

Buat Undangan

$ ant organization:invites create
POST/v1/organizations/invites

Undang pengguna untuk bergabung dengan organisasi melalui email.

Pada paket yang mengambil anggota dari kumpulan kursi terbatas yang dibeli, undangan secara otomatis menggunakan satu kursi dari tingkat terendah yang masih tersedia; tidak ada parameter tingkat kursi. Jika tidak ada kursi yang tersedia, permintaan gagal dengan error 400 alih-alih membeli kursi.

Parameters
--email: string

Email of the User.

formatemail
--role: "billing" or "claude_code_user" or "developer" or 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.

--rbac-group-id: optional array of 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
organization_invite: object{ type: "invite", id, accepted_at, 6 more }
type: "invite"

Object type.

For Invites, this is always "invite".

id: string

ID of the Invite.

accepted_at: string

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

formatdate-time
email: string

Email of the User being invited.

expires_at: string

RFC 3339 datetime string indicating when the Invite expires.

formatdate-time
invited_at: string

RFC 3339 datetime string indicating when the Invite was created.

formatdate-time
rbac_group_ids: array of string

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

role: "admin" or "billing" or "claude_code_user" or 6 more

Organization role of the User.

One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"
status: "accepted" or "deleted" or "expired" or "pending"

Status of the Invite.

One of the following:
"accepted"
"deleted"
"expired"
"pending"
Buat Undangan
ant organization:invites create \
  --api-key my-anthropic-api-key \
  --email user@emaildomain.com \
  --role user
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"
}