Skip to content
Console
Menu

Getting Started

Authentication

KV Store

On this page

sylphx broker token_exchanges

Every sylphx broker token_exchanges command: its argument, its flags and a run line.

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

#get

Gets the record of one issued credential.

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

CLI

Shell
sylphx broker token-exchanges get orgs/acme/trust_policies/trust-policy/token_exchanges/token-exchange

GET https://api.sylphx.com/v1/orgs/acme/trust_policies/trust-policy/token_exchanges/token-exchange · scope broker:read · effect read · Request, response and examples

#list

Lists the credentials issued under a trust policy, newest first.

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

CLI

Shell
sylphx broker token-exchanges list orgs/acme/trust_policies/trust-policy

GET https://api.sylphx.com/v1/orgs/acme/trust_policies/trust-policy/token_exchanges · scope broker: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.

#revoke

Revokes an issued credential at the provider by its record. The Broker uses the credential it holds sealed, so the caller needs no token and no live delegation. Idempotent: a credential already revoked or expired answers the record. Erases the sealed credential once the provider confirms.

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

CLI

Shell
sylphx broker token-exchanges revoke orgs/acme/trust_policies/trust-policy/token_exchanges/token-exchange --yes

POST https://api.sylphx.com/v1/orgs/acme/trust_policies/trust-policy/token_exchanges/token-exchange:revoke · scope broker:read · effect destructive · Request, response and examples

Flags

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