Deployments.ai Docs
Command reference

deployments invitation

Organization invitations

CommandSummary
deployments invitation listList pending invitations
deployments invitation createCreate an invitation
deployments invitation revokeRevoke an invitation
deployments invitation acceptAccept an invitation

deployments invitation list

List pending invitations.

deployments invitation list
  • Calls GET /v1/invitations (SDK listOrganizationInvitations).
  • Needs an organization: --org or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size

Also accepts the global flags.

deployments invitation create

Create an invitation.

deployments invitation create --email <email> --role <role>
  • Calls POST /v1/invitations (SDK createOrganizationInvitation).
  • Needs an organization: --org or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
--emailstringyesInvitee email
--rolestringyesOrganization role
--expires-atstringInvitation expiration timestamp

Also accepts the global flags.

deployments invitation revoke

Revoke an invitation.

deployments invitation revoke <id>
  • Calls DELETE /v1/invitations/{id} (SDK revokeOrganizationInvitation).
  • Needs an organization: --org or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--reasonstringReason for this operation

Also accepts the global flags.

deployments invitation accept

Accept an invitation.

deployments invitation accept <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--tokenstringInvitation token (prefer env or file source)
--token-envstringEnvironment variable containing the invitation token
--token-filestringFile containing the invitation token

Also accepts the global flags.

On this page