Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx auth memberships
Every sylphx auth memberships command: its argument, its flags and a run line.
The memberships commands of Sylphx Auth, as the CLI spells them: the same
calls as the memberships API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a membership.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx auth memberships get orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membershipGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membership · scope auth:read · effect read · Request, response and examples
#list
Lists memberships.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx auth memberships list orgs/acme/projects/shop/envs/production/customer_organizations/customer-organizationGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships · scope auth:read · effect read · Request, response and examples
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 a membership.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx auth memberships create --parent orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization --end-user …POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships · scope auth:write · effect write · Request, response and examples
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. |
--end-user | string | The member. Required. |
--roles | string | App-defined roles, for example admin. Repeat the flag for each value. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#update
Updates a membership.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx auth memberships update orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membershipPATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membership · scope auth:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--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. |
--roles | string | App-defined roles, for example admin. Repeat the flag for each value. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#delete
Deletes a membership.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx auth memberships delete orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membership --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membership · scope auth:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--allow-missing | bool | Succeed when the membership does not exist. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--yes | bool | Do not ask before this destructive call. |