Skip to content
Console
On this page

sylphx auth end_users

Every sylphx auth end_users command: its argument, its flags and a run line.

The end_users commands of Sylphx Auth, as the CLI spells them: the same calls as the end_users API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

import

Atomically admits an immutable bounded principal import batch.

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

CLI

Shell
sylphx auth end-users import orgs/acme/projects/shop/envs/production

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users:import · scope auth:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--schema-versionintSchema version of the typed principal input; must be 1. Required.
--batch-idstringUnique immutable batch identity within parent; lowercase run-id syntax. Required.
--key-namespacestringNamespace of the immutable source principal ID in each external_ids map. Required.
--usersjson1..100 principals. Duplicate source IDs are refused, never collapsed. Required. Repeat the flag for each value.

list-import-records

Returns an admitted import batch in canonical source_id order, including sensitive verifier input.

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

CLI

Shell
sylphx auth end-users list-import-records orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users:listImportRecords · scope auth:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--batch-idstringThe batch ID to read back. Required.
--page-sizeintAt most this many records; default 50, clamped to 100.
--page-tokenstringnext_page_token of the previous page.

get

Gets an end user.

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

CLI

Shell
sylphx auth end-users get orgs/acme/projects/shop/envs/production/end_users/end-user

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user · scope auth:read · effect read · Request, response and examples

list

Lists end users.

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

CLI

Shell
sylphx auth end-users list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users · 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 an end user.

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

CLI

Shell
sylphx auth end-users create --parent orgs/acme/projects/shop/envs/production

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users · 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.
--emailstringThe primary email address.
--passwordstringAn initial password; write-only, checked against breached passwords. The value is never returned.
--public-metadatajsonApp data readable by the end user's own tokens.
--private-metadatajsonApp data readable only with an Access key.
--unsafe-metadatajsonApp data the end user may write with their own session (preferences a sign-up form collects); never trust it for authorization.
--external-idskey=valueThe customer's own ids for this end user, one per namespace (game_user, steam_id): how an app that signs users in by its own id finds them again. Read on create; never changed through here, because a set namespace's value is never rewritten — AttachEndUserExternalId sets an unset one. At most four namespaces. Never an authorization input: scope checks use grant ids. Repeat the flag for each value.
--dry-runboolValidate and print the result without writing (validate_only).

update

Updates an end user.

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

CLI

Shell
sylphx auth end-users update orgs/acme/projects/shop/envs/production/end_users/end-user

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user · 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.
--emailstringThe primary email address.
--passwordstringAn initial password; write-only, checked against breached passwords. The value is never returned.
--public-metadatajsonApp data readable by the end user's own tokens.
--private-metadatajsonApp data readable only with an Access key.
--unsafe-metadatajsonApp data the end user may write with their own session (preferences a sign-up form collects); never trust it for authorization.
--external-idskey=valueThe customer's own ids for this end user, one per namespace (game_user, steam_id): how an app that signs users in by its own id finds them again. Read on create; never changed through here, because a set namespace's value is never rewritten — AttachEndUserExternalId sets an unset one. At most four namespaces. Never an authorization input: scope checks use grant ids. Repeat the flag for each value.
--dry-runboolValidate and print the result without writing (validate_only).

delete

Deletes an end user.

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

CLI

Shell
sylphx auth end-users delete orgs/acme/projects/shop/envs/production/end_users/end-user --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user · scope auth:write · effect destructive · Request, response and examples

Flags

FlagTypeWhat it does
--etagstringDelete only if the current etag matches.
--allow-missingboolSucceed when the end user does not exist.
--dry-runboolValidate and print the result without writing (validate_only).
--forceboolAlso delete the end user's memberships; sessions are always revoked.
--yesboolDo not ask before this destructive call.

suspend

Suspends an end user: sessions are revoked and sign-in is refused.

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

CLI

Shell
sylphx auth end-users suspend orgs/acme/projects/shop/envs/production/end_users/end-user --yes

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user:suspend · scope auth:write · effect destructive · Request, response and examples

Flags

FlagTypeWhat it does
--reasonstringWhy; shown to administrators only.
--etagstringAct only if the current etag matches.
--yesboolDo not ask before this destructive call.

reactivate

Reactivates a suspended end user.

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

CLI

Shell
sylphx auth end-users reactivate orgs/acme/projects/shop/envs/production/end_users/end-user

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user:reactivate · scope auth:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--etagstringAct only if the current etag matches.

unlock

Clears an end user's sign-in lock (repeated failed sign-ins) now.

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

CLI

Shell
sylphx auth end-users unlock orgs/acme/projects/shop/envs/production/end_users/end-user

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user:unlock · scope auth:write · effect write · Request, response and examples

revoke-sessions

Revokes every session of an end user.

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

CLI

Shell
sylphx auth end-users revoke-sessions orgs/acme/projects/shop/envs/production/end_users/end-user --yes

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user:revokeSessions · scope auth:write · effect destructive · Request, response and examples

Flags

FlagTypeWhat it does
--yesboolDo not ask before this destructive call.

attach-external-id

Sets the customer's own id for an end user, once: an unset namespace is written, a set one is never rewritten, and a different value for a set namespace is refused. A namespace holds one id for the life of the user. Erasure removes the ids and remembers their hashes, so a value that belonged to an erased user is never handed to another one.

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

CLI

Shell
sylphx auth end-users attach-external-id orgs/acme/projects/shop/envs/production/end_users/end-user

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user:attachExternalId · scope auth:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--namespacestringThe customer's namespace for this id: ^[a-z][a-z0-9_]{0,31}$. Required.
--external-idstringThe id itself, 1 to 128 printable characters, unique in its namespace across the environment's live users. Required.

find

Finds the one end user of one of the customer's own ids. An id that belongs to no live user of this environment is RESOURCE_NOT_FOUND, the same answer a value erased with its user gives.

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

CLI

Shell
sylphx auth end-users find orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users:find · scope auth:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--namespacestringThe customer's namespace of the id. Required.
--external-idstringThe id to find. Required.