This page describes AAES Govern’s controls. AAES Operate has private-work permissions, operational reviews and recorded-spend limits; it does not include Govern. About AAES Govern
Before you enable this package
Keep circleci.com. Bind PROJECT_SLUG, PIPELINE_ID, WORKFLOW_ID and APPROVAL_REQUEST_ID to the intended request targets. A self-hosted server requires a reviewed package change.
Read each action's effects and exclusions below. Before installation, also read the complete package requirements, including credential issuance, scope, expiry, and provider permissions. These are deployment prerequisites, not capabilities this package supplies.
Capabilities (6)
Each capability below is one registered operation. The complete package JSON includes its exact network destination allowlist. The repository stores it at packs/circleci.json and embeds a copy in the release binary.
Risk tiers. R0 is the minimum for reads. R2 is the minimum for write, create, update, execute, and invoke. R3 is the minimum for delete, send, pay, deploy, approve, share, and transfer. Operators can raise these levels. A minimum tier does not measure the operation's business or confidentiality risk.
On supported execution paths routed through AAES Govern, the R3 actions listed below require approval by an authorized person. Bypass paths and observation-only registrations are outside that guarantee. A provider's restoration feature does not remove this approval requirement. A provider-side approval, such as approving a GitLab merge request, is also separate from AAES Govern human approval. The capability matrix shows which execution paths are implemented, restricted to lab use, or refused at startup. Live compatibility must be tested in your environment.
Field guide. Endpoint is the service address and request method. Connector is the adapter that makes the call. Custody describes how the credential is held; the credential reference identifies the value to resolve. Data class sets handling requirements: pii means personal data, financial means financial records, and internal means internal organizational data.
circleci.project.read v1.0.0R0
- Kind
- tool
- Action
- read
- Endpoint
GET https://circleci.com/api/v2/project/PROJECT_SLUG- Connector
- http
- Custody
- customer_vault
- Credential ref
secret-ref-circleci-personal-api-token- Data class
- internal
Read project.
Read one project's record via GET /api/v2/project/PROJECT_SLUG. This pack does not register project listing, so this is a record read addressed by the caller-supplied slug — project settings, environment variables, and checkout keys are not registered by this pack. PROJECT_SLUG is a placeholder the deployment binds to a concrete project before enabling.
circleci.pipelines.read v1.0.0R0
- Kind
- tool
- Action
- read
- Endpoint
GET https://circleci.com/api/v2/project/PROJECT_SLUG/pipeline- Connector
- http
- Custody
- customer_vault
- Credential ref
secret-ref-circleci-personal-api-token- Data class
- pii
Read pipelines.
List pipelines for one project via GET /api/v2/project/PROJECT_SLUG/pipeline.
The registered path covers the collection read only — single pipeline records and pipeline configuration reads are not registered by this pack. PROJECT_SLUG is a placeholder the deployment binds to a concrete project before enabling.
circleci.workflows.read v1.0.0R0
- Kind
- tool
- Action
- read
- Endpoint
GET https://circleci.com/api/v2/pipeline/PIPELINE_ID/workflow- Connector
- http
- Custody
- customer_vault
- Credential ref
secret-ref-circleci-personal-api-token- Data class
- internal
Read workflows.
List the workflows of one pipeline via GET /api/v2/pipeline/PIPELINE_ID/workflow.
The registered path covers the collection read only — single workflow records are not registered by this pack. PIPELINE_ID is a placeholder the deployment binds to a concrete pipeline before enabling.
circleci.jobs.read v1.0.0R0
- Kind
- tool
- Action
- read
- Endpoint
GET https://circleci.com/api/v2/workflow/WORKFLOW_ID/job- Connector
- http
- Custody
- customer_vault
- Credential ref
secret-ref-circleci-personal-api-token- Data class
- internal
Read jobs.
List the jobs of one workflow via GET /api/v2/workflow/WORKFLOW_ID/job.
The registered path covers the collection read only — single job records, test metadata, and artifacts are not registered by this pack. WORKFLOW_ID is a placeholder the deployment binds to a concrete workflow before enabling.
circleci.pipeline.trigger v1.0.0R3
- Kind
- tool
- Action
- deploy
- Endpoint
POST https://circleci.com/api/v2/project/PROJECT_SLUG/pipeline- Connector
- http
- Custody
- customer_vault
- Credential ref
secret-ref-circleci-personal-api-token- Data class
- internal
Trigger pipeline.
Start a pipeline for one project with POST /api/v2/project/PROJECT_SLUG/pipeline. The caller selects a branch or tag and supplies pipeline parameters. Pipelines may deploy changes, consume credits, and produce effects this pack cannot undo.
Compatibility: this is CircleCI’s superseded legacy trigger, for GitHub OAuth app and Bitbucket Cloud projects; the slug’s version-control component is gh or bb. It does not support GitLab or GitHub App pipelines. Confirm the project’s integration type in CircleCI before enabling; a valid slug alone is insufficient.
The newer pipeline-run endpoint is excluded. Its documented config sources are github_app, github_server, github_oauth, bitbucket_dc, and bitbucket_oauth; neither documented trigger supports GitLab.
Classification: deploy, minimum R3, because a triggered pipeline can perform deployments.
On supported execution paths mediated by AAES Govern, an authorized person must approve the action. This cannot stop observation-only or bypass calls. Bind PROJECT_SLUG before enabling.
circleci.job.approve v1.0.0R3
- Kind
- tool
- Action
- approve
- Endpoint
POST https://circleci.com/api/v2/workflow/WORKFLOW_ID/approve/APPROVAL_REQUEST_ID- Connector
- http
- Custody
- customer_vault
- Credential ref
secret-ref-circleci-personal-api-token- Data class
- internal
Approve job.
Approve a pending approval job with POST /api/v2/workflow/WORKFLOW_ID/approve/APPROVAL_REQUEST_ID. This records approval under the caller’s identity and opens the gate for protected workflow continuation, commonly a deployment. No endpoint in this pack can withdraw it, so the pack makes no general reversibility claim.
Classification: approve, minimum R3.
On supported execution paths mediated by AAES Govern, an authorized person must approve the irreversible action. This cannot stop observation-only or bypass calls. Bind WORKFLOW_ID and APPROVAL_REQUEST_ID before enabling.
Credential reference
The credential field names a reference rather than containing credential material. Packs are designed not to contain secrets; the format checks cover only known credential formats and cannot prove that arbitrary text contains no secrets. Installing a package registers its capabilities. Configure the provider credentials, endpoints, and network access, then test the integration in your environment before enabling it.
- Reference
secret-ref-circleci-personal-api-token- Custody
- customer_vault
- Injection
- header (Circle-Token)
Configure the value and injection format specified in the package. Assign responsibility for credential rotation and revocation, restrict provider permissions, and keep credential material out of logs and responses.
Complete credential requirements
A CircleCI personal API token, held in the client's own secret manager. The stored material must be the complete Circle-Token header value: the token itself, with no scheme prefix added. CircleCI documents the Circle-Token header as the primary API v2 authentication, and also accepts RFC 6750 bearer and HTTP Basic (token as username, blank password) forms; the query-parameter form is deprecated and must not be used.
CircleCI documents that personal API tokens grant full read and write access as the owning user with no scope reduction available, and that project API tokens are not supported on API v2 — so the only least-privilege control available is a dedicated token on an account with the minimum project access, and nothing broader; review that account's permissions before enabling. CircleCI documents no token expiry: deleting the token in user settings is the revocation path and invalidates that issued token, and rotation means deleting and recreating it.
Renewal ownership sits with an external deployment process: the executor injects the stored value verbatim and performs no token lifecycle itself, and it must never substitute a different credential without an approved pack change.
Executor hygiene: the value must live only in executor memory for the lifetime of a call, must never be written to logs, traces or diagnostics, and must not appear in crash dumps; a deployment that cannot meet that bar must not enable the pack.
Resources
circleci-project(api, pii):https://circleci.com/api/v2/project/PROJECT_SLUG
Technical package and review record
Complete provider requirements and exclusions
The registered host is circleci.com (CircleCI cloud). Self-hosted CircleCI server installations use an installer-specific host: substituting it into the endpoints, the resource locator and the egress allowlist is a pack change that requires re-review before enablement. PROJECT_SLUG, PIPELINE_ID, WORKFLOW_ID and APPROVAL_REQUEST_ID in the endpoint paths are placeholders the deployment binds to concrete values per request target (PROJECT_SLUG is the vcs-slug/org-name/repo-name triple, for example gh/example-org/example-repo); the registered paths do not change.
This pack registers only endpoints the public CircleCI API v2 documentation and its published OpenAPI specification describe: reading one project, listing a project's pipelines, listing a pipeline's workflows, listing a workflow's jobs, triggering a pipeline, and approving a pending approval job.
Documented exclusions: the newer recommended pipeline-run endpoint (which the provider documents as superseding the registered trigger), pipeline continuation, workflow rerun and cancel, job cancel, schedule and trigger management, contexts, environment variables, project settings, checkout keys, webhooks, organization administration, and every endpoint outside the registered list; each addition is a pack change and requires its own review.
Integration scope of the registered trigger: CircleCI's published OpenAPI specification states that the registered legacy trigger does not support triggering pipelines integrated with GitLab or GitHub App, and that it is superseded by a newer pipeline-run endpoint supporting pipeline definitions whose config source is github_app, github_server, github_oauth, bitbucket_dc or bitbucket_oauth — that is, all organization and pipeline types except GitLab, which neither documented trigger serves.
The registered legacy trigger therefore fits projects on the GitHub OAuth app and Bitbucket Cloud integrations, and a well-formed PROJECT_SLUG alone does not establish compatibility — confirm the project's integration type in the CircleCI web app before enabling.
Approval classification: reads sit at the minimum R0 tier. pipeline.trigger is registered as deploy at the minimum R3 tier because CircleCI documents that the request body lets the caller choose the branch or tag and pass pipeline parameters, and CircleCI pipelines commonly perform deployments — deploy is one of the designated actions requiring human approval. job.approve is registered as approve at the minimum R3 tier because an approval job is the documented gate before protected continuation of a workflow, commonly a deployment, and the approval is recorded under the caller's identity — approve is one of the designated actions requiring human approval. AAES has not been certified by CircleCI; review and test this configuration; it is not a vendor guarantee.
Download the complete package JSON for exact network allowlists, credential requirements, exclusions, and setup notes. Read these requirements before installation.
The full documentation review record is supplied in the evaluation package. The evaluation package runs in your environment and comes only with the paid design partnership. This page reproduces the source links and review block; the full record is available for evaluation. Discuss a design partnership to inspect it before installation.
Review block
This section reproduces the review block recorded in the pack file. The evidence and approval record is separate: for a reviewed pack, it is in the evaluation materials and in the release binary's embedded assets.
Review completed: 2026-09-22
4 sources, retrieved 2026-09-21
- https://circleci.com/docs/api/v2/ (retrieved 2026-09-21)
- https://circleci.com/api/v2/openapi.json (retrieved 2026-09-21)
- https://circleci.com/docs/managing-api-tokens/ (retrieved 2026-09-21)
- https://circleci.com/docs/triggers-overview/ (retrieved 2026-09-21)
Current documentation links are navigation aids. They do not change the package, its historical sources or its review date. Review dates describe a documentation review, not a live integration test. No package is provider-endorsed or yet tested against a live provider tenant.
Release identity
SHA-256 of the pack file bytes: d3b9b5b866e63c1c0383393969508f4be505ddc7b6bc9a17ab1515cd4c3dc9ab
Distributable: yes, digest matches the release manifest. Editing a package changes its release identity. A deployment plan checks its own file digests; it does not restore reviewed status or authenticate approval.