---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "sylphx auth invitations"
description: "The sylphx auth invitations commands of Sylphx Auth: every verb, with its argument, its flags and a run line."
type: reference
product: organizations
summary: "Every sylphx auth invitations command: its argument, its flags and a run line."
updated: 2026-09-28
nav: false
---

The `invitations` commands of Sylphx Auth, as the CLI spells them: the same
calls as [the `invitations` API page](/docs/api/invitations), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

## get

Gets an invitation.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx auth invitations get orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations/invitation
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations/invitation` · scope `auth:read` · effect `read` · [Request, response and examples](/docs/api/invitations/get)

## list

Lists invitations.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx auth invitations list orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations` · scope `auth:read` · effect `read` · [Request, response and examples](/docs/api/invitations/list)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | At most this many; default 50, clamped to 1000. |
| `--page-token` | `string` | `next_page_token` of the previous page. |
| `--filter` | `string` | AIP-160 filter over labels and filterable fields. |
| `--order-by` | `string` | AIP-132 ordering over filterable fields. |

## create

Creates an invitation.

**`ID`** — The id segment of the new Resource's name; the server assigns one when omitted.

**CLI**

```bash
sylphx auth invitations create --parent orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization --email …
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations` · scope `auth:write` · effect `write` · [Request, response and examples](/docs/api/invitations/create)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--parent` | `string` | The parent to create in; defaults to the linked project or the key's scope. |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--email` | `string` | The invited address. Required. |
| `--roles` | `string` | Roles the membership gets; empty means the environment's default roles. Repeat the flag for each value. |
| `--ttl` | `duration` | How long it stays open; default 7 days, at most 30. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |

## revoke

Revokes a pending invitation.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx auth invitations revoke orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations/invitation --yes
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations/invitation:revoke` · scope `auth:write` · effect `destructive` · [Request, response and examples](/docs/api/invitations/revoke)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--yes` | `bool` | Do not ask before this destructive call. |

## accept

Accepts a pending invitation for an end user whose verified email is the invited address, and creates the membership.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx auth invitations accept orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations/invitation
```

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/invitations/invitation:accept` · scope `auth:write` · effect `write` · [Request, response and examples](/docs/api/invitations/accept)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--end-user` | `string` | The accepting end user; its verified email must be the invited address. Required. |