Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

On this page

sylphx money portal_sessions

Every sylphx money portal_sessions command: its argument, its flags and a run line.

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

#create

Creates a customer portal session for a subject.

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

CLI

Shell
sylphx money portal-sessions create --parent orgs/acme/projects/shop/envs/production --return-url …

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/portal_sessions · scope billing: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.
--subject.end-userstringAn end user's id (Sylphx Auth, or the app's own OIDC issuer).
--subject.customer-organizationstringA customer organization's id.
--return-urlstringWhere the portal's back link goes. HTTPS only. Required.

#get

Gets a portal session.

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

CLI

Shell
sylphx money portal-sessions get orgs/acme/projects/shop/envs/production/portal_sessions/portal-session

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/portal_sessions/portal-session · scope billing:read · effect read · Request, response and examples