Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

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

Shell
sylphx auth memberships get orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membership

GET 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

Shell
sylphx auth memberships 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/memberships · scope auth:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-160 filter over labels and filterable fields.
--order-bystringAIP-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

Shell
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

FlagTypeWhat it does
--parentstringThe parent to create in; defaults to the linked project or the key's scope.
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--end-userstringThe member. Required.
--rolesstringApp-defined roles, for example admin. Repeat the flag for each value.
--dry-runboolValidate 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

Shell
sylphx auth memberships update orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membership

PATCH 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

FlagTypeWhat it does
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--rolesstringApp-defined roles, for example admin. Repeat the flag for each value.
--dry-runboolValidate 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

Shell
sylphx auth memberships delete orgs/acme/projects/shop/envs/production/customer_organizations/customer-organization/memberships/membership --yes

DELETE 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

FlagTypeWhat it does
--etagstringDelete only if the current etag matches.
--allow-missingboolSucceed when the membership does not exist.
--dry-runboolValidate and print the result without writing (validate_only).
--yesboolDo not ask before this destructive call.