Claude Platform Docs

Créer une invitation

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

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

Sur les forfaits dont les membres proviennent d'un ensemble fini de sièges achetés, l'invitation consomme automatiquement un siège du niveau le plus bas disponible ; il n'existe pas de 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.

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.

--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
beta_organization_invite: object{ id, accepted_at, email, 6 more }
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"
type: "invite"

Object type.

For Invites, this is always "invite".

Créer une invitation
ant beta: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"
}