Command reference
deployments invitation
Organization invitations
| Command | Summary |
|---|---|
deployments invitation list | List pending invitations |
deployments invitation create | Create an invitation |
deployments invitation revoke | Revoke an invitation |
deployments invitation accept | Accept an invitation |
deployments invitation list
List pending invitations.
deployments invitation list- Calls
GET /v1/invitations(SDKlistOrganizationInvitations). - Needs an organization:
--orgor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (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(SDKcreateOrganizationInvitation). - Needs an organization:
--orgor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely. - Output contains secrets. They are redacted unless you pass
--reveal.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--email | string | yes | Invitee email | |
--role | string | yes | Organization role | |
--expires-at | string | Invitation expiration timestamp |
Also accepts the global flags.
deployments invitation revoke
Revoke an invitation.
deployments invitation revoke <id>- Calls
DELETE /v1/invitations/{id}(SDKrevokeOrganizationInvitation). - Needs an organization:
--orgor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--reason | string | Reason for this operation |
Also accepts the global flags.
deployments invitation accept
Accept an invitation.
deployments invitation accept <id>- Calls
POST /v1/invitations/{id}/accept(SDKacceptOrganizationInvitation). - No tenancy context required.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--token | string | Invitation token (prefer env or file source) | ||
--token-env | string | Environment variable containing the invitation token | ||
--token-file | string | File containing the invitation token |
Also accepts the global flags.