On this page
Create a trust policy
Creates a trust policy.
Creates a trust policy.
- Path
POST https://api.sylphx.com/v1/orgs/acme/trust_policies - Scope
broker:admin - Effect
write— a successful call changes state. - Collection trust_policies
- Query
trust_policy_id,validate_only
Request
| Field | Type | What it is |
|---|---|---|
parent | string | The org to create in. Required. |
trust_policy | TrustPolicy | The trust policy to create; only spec and caller-writable metadata are read. Required. |
trust_policy_id | string | The id of the new trust policy, ^[a-z]([a-z0-9_-]{0,61}[a-z0-9])?$; the server assigns one when empty. |
validate_only | bool | Validate and return the result without writing anything. |
TrustPolicy
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/trust_policies/{trust_policy}. |
meta | ResourceMeta | Resource metadata. |
spec | TrustPolicySpec | Desired state. Required. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
TrustPolicySpec
| Field | Type | What it is |
|---|---|---|
connection | string | The Connection credentials are issued on: An active GitHub installation, GitHub user, OAuth 2.0, or Web Push Connection in the same org. Required. |
subjects | string[] | The Access principals allowed to exchange, orgs/{org}/principals/{id} in the policy's org: the caller's own principal, or the accountable principal of a delegated grant. 1 to 64. Required. |
permissions | map<string, string> | Empty for a VAPID assertion or generic OAuth 2.0 Connection. Otherwise the GitHub permission ceiling, for example {"contents": "write", "pull_requests": "write"}. administration is read only; organization permissions are refused. A policy with actors carries at most contents and pull_requests. |
repositories | string[] | Empty for a VAPID assertion or generic OAuth 2.0 Connection. Otherwise 1 to 1000 exact owner/name entries, no wildcard, each owned by the Connection's account. One exchange covers exactly one repository. |
credential_kind | CredentialKind | What Broker issues: access_token or vapid_assertion on the wire. Required. One of access_token, runner_registration, vapid_assertion. |
max_ttl | duration | The longest a credential lives: GitHub default/maximum 3600s; OAuth 2.0 and VAPID default/maximum 86400s (capped by upstream expiry). Positive whole seconds only for VAPID. |
actors | string[] | The Agents a delegated grant may act for: an Agent name orgs/{org}/projects/{project}/envs/{env}/agents/{agent}, or every Agent of an environment, .../envs/{env}/agents/*. 0 to 64. When set, only a delegated grant whose actor matches may exchange; a grant with no actor is refused. When empty, any grant of a subject may exchange, delegated or not. |
github_action_budget | GitHubActionBudget | Required for GitHub user actions. Zero denies actions; ceilings are 80 per minute and 500 per hour. This policy budget does not replace GitHub limits. |
GitHubActionBudget
| Field | Type | What it is |
|---|---|---|
per_minute | int32 | Maximum admissions in a rolling 60-second window; 1 to 80. Required. |
per_hour | int32 | Maximum admissions in a rolling 3600-second window; 1 to 500. Required. |
Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/trust_policies/{trust_policy}. |
uid | string | tpol_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | TrustPolicySpec | Desired state. Required. |
status | TrustPolicyStatus | Observed state. Output only. |
ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
TrustPolicySpec
| Field | Type | What it is |
|---|---|---|
connection | string | The Connection credentials are issued on: An active GitHub installation, GitHub user, OAuth 2.0, or Web Push Connection in the same org. Required. |
subjects | string[] | The Access principals allowed to exchange, orgs/{org}/principals/{id} in the policy's org: the caller's own principal, or the accountable principal of a delegated grant. 1 to 64. Required. |
permissions | map<string, string> | Empty for a VAPID assertion or generic OAuth 2.0 Connection. Otherwise the GitHub permission ceiling, for example {"contents": "write", "pull_requests": "write"}. administration is read only; organization permissions are refused. A policy with actors carries at most contents and pull_requests. |
repositories | string[] | Empty for a VAPID assertion or generic OAuth 2.0 Connection. Otherwise 1 to 1000 exact owner/name entries, no wildcard, each owned by the Connection's account. One exchange covers exactly one repository. |
credential_kind | CredentialKind | What Broker issues: access_token or vapid_assertion on the wire. Required. One of access_token, runner_registration, vapid_assertion. |
max_ttl | duration | The longest a credential lives: GitHub default/maximum 3600s; OAuth 2.0 and VAPID default/maximum 86400s (capped by upstream expiry). Positive whole seconds only for VAPID. |
actors | string[] | The Agents a delegated grant may act for: an Agent name orgs/{org}/projects/{project}/envs/{env}/agents/{agent}, or every Agent of an environment, .../envs/{env}/agents/*. 0 to 64. When set, only a delegated grant whose actor matches may exchange; a grant with no actor is refused. When empty, any grant of a subject may exchange, delegated or not. |
github_action_budget | GitHubActionBudget | Required for GitHub user actions. Zero denies actions; ceilings are 80 per minute and 500 per hour. This policy budget does not replace GitHub limits. |
TrustPolicyStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready: the policy was admitted against an active installation. A permission the installation lacks is refused at exchange with reason CapabilityMissing. Output only. |
GitHubActionBudget
| Field | Type | What it is |
|---|---|---|
per_minute | int32 | Maximum admissions in a rolling 60-second window; 1 to 80. Required. |
per_hour | int32 | Maximum admissions in a rolling 3600-second window; 1 to 500. Required. |
Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.RESOURCE_ALREADY_EXISTS— A Resource with this name exists.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.PLAN_LIMIT_REACHED— The plan's limit is reached.
Every error arrives in the body Errors describes.
Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/trust_policies" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"spec":{"connection":"…","credential_kind":"access_token","subjects":["…"]}}'