Skip to content
Console
Menu

Getting Started

Authentication

KV Store

sylphx broker trust_policies

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

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

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

Not available yet. Sylphx Broker is declared in the registry but no backend serves it: every command answers 501 with the problem code UNIMPLEMENTED.

#get

Gets a trust policy.

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

CLI

Shell
sylphx broker trust-policies get orgs/acme/trust_policies/trust-policy

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

#list

Lists an org's trust policies.

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

CLI

Shell
sylphx broker trust-policies list orgs/acme

GET https://api.sylphx.com/v1/orgs/acme/trust_policies · 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.
--filterstringAIP-160 filter over labels and filterable fields.
--order-bystringAIP-132 ordering over filterable fields.

#create

Creates a trust policy.

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

CLI

Shell
sylphx broker trust-policies create --parent orgs/acme --spec.connection … --spec.credential-kind access_token

POST https://api.sylphx.com/v1/orgs/acme/trust_policies · scope broker:admin · 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.
--spec.connectionstringThe Connection credentials are issued on. Required.
--spec.subjectsstringThe identities allowed to exchange: SPIFFE ids (spiffe://<trust-domain>/cell/<cell>/role/<role>, * matching one segment) or Sylphx Access principal names. The cell segment is never stripped. Required. Repeat the flag for each value.
--spec.permissionskey=valueThe most a credential may carry, in the provider's permission names, for example {"contents": "read", "checks": "write"}. Required. Repeat the flag for each value.
--spec.repositoriesstringThe most repositories a credential may cover; empty means every repository the Connection covers. Repeat the flag for each value.
--spec.credential-kindenumWhat the credential service issues. Required. One of access_token, runner_registration.
--spec.max-ttldurationThe longest a credential lives; default and maximum 1 hour.
--dry-runboolValidate and print the result without writing (validate_only).

#update

Updates a trust policy.

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

CLI

Shell
sylphx broker trust-policies update orgs/acme/trust_policies/trust-policy --spec.connection … --spec.credential-kind access_token

PATCH https://api.sylphx.com/v1/orgs/acme/trust_policies/trust-policy · scope broker:admin · 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.
--spec.connectionstringThe Connection credentials are issued on. Required.
--spec.subjectsstringThe identities allowed to exchange: SPIFFE ids (spiffe://<trust-domain>/cell/<cell>/role/<role>, * matching one segment) or Sylphx Access principal names. The cell segment is never stripped. Required. Repeat the flag for each value.
--spec.permissionskey=valueThe most a credential may carry, in the provider's permission names, for example {"contents": "read", "checks": "write"}. Required. Repeat the flag for each value.
--spec.repositoriesstringThe most repositories a credential may cover; empty means every repository the Connection covers. Repeat the flag for each value.
--spec.credential-kindenumWhat the credential service issues. Required. One of access_token, runner_registration.
--spec.max-ttldurationThe longest a credential lives; default and maximum 1 hour.
--dry-runboolValidate and print the result without writing (validate_only).

#delete

Deletes a trust policy.

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

CLI

Shell
sylphx broker trust-policies delete orgs/acme/trust_policies/trust-policy --yes

DELETE https://api.sylphx.com/v1/orgs/acme/trust_policies/trust-policy · scope broker:admin · effect destructive · Request, response and examples

Flags

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

#exchange-token

Exchanges the caller's workload identity for a short-lived provider credential under a trust policy (RFC 8693 token exchange). The credential is narrowed to the request and cached per installation and permission set; a permission the Connection lacks is PERMISSION_DENIED with reason CapabilityMissing, never an outage.

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

CLI

Shell
sylphx broker trust-policies exchange-token orgs/acme/trust_policies/trust-policy

POST https://api.sylphx.com/v1/orgs/acme/trust_policies/trust-policy:exchangeToken · scope broker:exchange · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--subject-tokenstringThe caller's identity: a SPIFFE JWT-SVID or an Access-issued workload OIDC token, with audience broker.sylphx.com. Required. The value is never returned.
--permissionskey=valueThe permissions this call needs, at most the policy's; empty means the policy's. Repeat the flag for each value.
--repositoriesstringThe repositories this call needs, at most the policy's; empty means the policy's. Repeat the flag for each value.
--ttldurationHow long the credential should live, at most the policy's max_ttl.