/circleci-admin | Type: Application | PCID required: Yes
Tools
circleci_admin_create_organization
Create a new organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name of the organization. |
vcs_type | string | Yes | — | The version control system type for the organization. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The name of the organization."
},
"vcs_type": {
"type": "string",
"description": "The version control system type for the organization.",
"enum": [
"github",
"bitbucket",
"circleci"
]
}
},
"required": [
"PCID",
"name",
"vcs_type"
]
}
circleci_admin_create_organization_group
Create Groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | An opaque identifier of an organization. |
description | string | No | — | Description to describe the group |
name | string | Yes | — | Name of the group |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "An opaque identifier of an organization."
},
"description": {
"type": "string",
"description": "Description to describe the group"
},
"name": {
"type": "string",
"description": "Name of the group"
}
},
"required": [
"PCID",
"org_id",
"name"
]
}
circleci_admin_create_otel_exporter
🧪 Create an OTLP exporter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
endpoint | string | Yes | — | The OTLP endpoint to send spans to. Don’t include https:// or grpc://. Just the hostname and port are required. |
headers | object | No | — | Additional headers to include in export requests. |
insecure | boolean | No | — | Whether to use an insecure connection to the endpoint. |
org_id | string | Yes | — | The organization ID to create the exporter for. |
protocol | string | Yes | — | The OTLP transport to use when exporting data. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"endpoint": {
"type": "string",
"description": "The OTLP endpoint to send spans to. Don't include https:// or grpc://. Just the hostname and port are required."
},
"headers": {
"type": "object",
"description": "Additional headers to include in export requests."
},
"insecure": {
"type": "boolean",
"description": "Whether to use an insecure connection to the endpoint."
},
"org_id": {
"type": "string",
"description": "The organization ID to create the exporter for."
},
"protocol": {
"type": "string",
"description": "The OTLP transport to use when exporting data.",
"enum": [
"grpc",
"http"
]
}
},
"required": [
"PCID",
"endpoint",
"org_id",
"protocol"
]
}
circleci_admin_create_policy_bundle
Creates policy bundle for the context Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ownerID | string | Yes | — | Owner ID |
context | string | Yes | — | The context value |
dry | boolean | No | — | The dry value |
policies | object | No | — | The policies value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ownerID": {
"type": "string",
"description": "Owner ID"
},
"context": {
"type": "string",
"description": "The context value"
},
"dry": {
"type": "boolean",
"description": "The dry value"
},
"policies": {
"type": "object",
"description": "The policies value"
}
},
"required": [
"PCID",
"ownerID",
"context"
]
}
circleci_admin_create_urlorb_allow_list_entry
Create a new URL Orb allow-list entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org-slug-or-id | string | Yes | — | Org UUID or slug in the form vcs-slug/org-name. For projects that use GitLab or GitHub App, use circleci as the vcs-slug and replace the org-name with the organization ID (found in Organization Settings). |
auth | string | Yes | — | An authentication method to use for fetching URL orb references that match this allow-list entry’s prefix. Allowed values are “bitbucket-oauth”, “github-oauth”, “github-app”, or “none”. |
name | string | Yes | — | Name of the URL orb allow-list entry. |
prefix | object | Yes | — | URL prefix. URL orb references that start with this prefix will be allowed by this allow-list entry. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org-slug-or-id": {
"type": "string",
"description": "Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)."
},
"auth": {
"type": "string",
"description": "An authentication method to use for fetching URL orb references that match this allow-list entry's prefix. Allowed values are \"bitbucket-oauth\", \"github-oauth\", \"github-app\", or \"none\".",
"enum": [
"github-oauth",
"none",
"bitbucket-oauth",
"github-app"
]
},
"name": {
"type": "string",
"description": "Name of the URL orb allow-list entry."
},
"prefix": {
"description": "URL prefix. URL orb references that start with this prefix will be allowed by this allow-list entry."
}
},
"required": [
"PCID",
"org-slug-or-id",
"auth",
"name",
"prefix"
]
}
circleci_admin_create_webhook
Create an outbound webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
events | string[] | Yes | — | Events that will trigger the webhook |
name | string | Yes | — | Name of the webhook |
scope | object | Yes | — | The scope in which the relevant events that will trigger webhooks |
signing-secret | string | Yes | — | Secret used to build an HMAC hash of the payload and passed as a header in the webhook request |
url | string | Yes | — | URL to deliver the webhook to. Note: protocol must be included as well (only https is supported) |
verify-tls | boolean | Yes | — | Whether to enforce TLS certificate verification when delivering the webhook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"workflow-completed",
"job-completed"
]
},
"description": "Events that will trigger the webhook"
},
"name": {
"type": "string",
"description": "Name of the webhook"
},
"scope": {
"type": "object",
"description": "The scope in which the relevant events that will trigger webhooks",
"properties": {
"id": {
"type": "string",
"description": "ID of the scope being used (at the moment, only project ID is supported)"
},
"type": {
"type": "string",
"description": "Type of the scope being used",
"enum": [
"project"
]
}
},
"required": [
"id",
"type"
]
},
"signing-secret": {
"type": "string",
"description": "Secret used to build an HMAC hash of the payload and passed as a header in the webhook request"
},
"url": {
"type": "string",
"description": "URL to deliver the webhook to. Note: protocol must be included as well (only https is supported)"
},
"verify-tls": {
"type": "boolean",
"description": "Whether to enforce TLS certificate verification when delivering the webhook"
}
},
"required": [
"PCID",
"events",
"name",
"scope",
"signing-secret",
"url",
"verify-tls"
]
}
circleci_admin_delete_group
Delete a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | An opaque identifier of an organization. |
group_id | string | Yes | — | An opaque identifier of a group. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "An opaque identifier of an organization."
},
"group_id": {
"type": "string",
"description": "An opaque identifier of a group."
}
},
"required": [
"PCID",
"org_id",
"group_id"
]
}
circleci_admin_delete_org_claims
Delete org-level claims Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgID | string | Yes | — | Org ID |
claims | string | Yes | — | comma separated list of claims to delete. Valid values are “audience” and “ttl”. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"orgID": {
"type": "string",
"description": "Org ID"
},
"claims": {
"type": "string",
"description": "comma separated list of claims to delete. Valid values are \"audience\" and \"ttl\"."
}
},
"required": [
"PCID",
"orgID",
"claims"
]
}
circleci_admin_delete_organization
Delete an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org-slug-or-id | string | Yes | — | Org UUID or slug in the form vcs-slug/org-name. For projects that use GitLab or GitHub App, use circleci as the vcs-slug and replace the org-name with the organization ID (found in Organization Settings). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org-slug-or-id": {
"type": "string",
"description": "Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)."
}
},
"required": [
"PCID",
"org-slug-or-id"
]
}
circleci_admin_delete_otel_exporter
🧪 Delete an OTLP exporter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
otel_exporter_id | string | Yes | — | The ID of an OTLP exporter configuration. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"otel_exporter_id": {
"type": "string",
"description": "The ID of an OTLP exporter configuration."
}
},
"required": [
"PCID",
"otel_exporter_id"
]
}
circleci_admin_delete_project_claims
Delete project-level claims Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgID | string | Yes | — | Org ID |
projectID | string | Yes | — | Project ID |
claims | string | Yes | — | comma separated list of claims to delete. Valid values are “audience” and “ttl”. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"orgID": {
"type": "string",
"description": "Org ID"
},
"projectID": {
"type": "string",
"description": "Project ID"
},
"claims": {
"type": "string",
"description": "comma separated list of claims to delete. Valid values are \"audience\" and \"ttl\"."
}
},
"required": [
"PCID",
"orgID",
"projectID",
"claims"
]
}
circleci_admin_delete_webhook
Delete an outbound webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook-id | string | Yes | — | ID of the webhook (UUID) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook-id": {
"type": "string",
"description": "ID of the webhook (UUID)"
}
},
"required": [
"PCID",
"webhook-id"
]
}
circleci_admin_get_collaborations
CollaborationsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
circleci_admin_get_current_user
User InformationShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
circleci_admin_get_decision_log
Retrieves the owner’s decision audit log by given decisionID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ownerID | string | Yes | — | Owner ID |
context | string | Yes | — | The context value |
decisionID | string | Yes | — | Decision ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ownerID": {
"type": "string",
"description": "Owner ID"
},
"context": {
"type": "string",
"description": "The context value"
},
"decisionID": {
"type": "string",
"description": "Decision ID"
}
},
"required": [
"PCID",
"ownerID",
"context",
"decisionID"
]
}
circleci_admin_get_decision_log_policy_bundle
Retrieves Policy Bundle for a given decision log ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ownerID | string | Yes | — | Owner ID |
context | string | Yes | — | The context value |
decisionID | string | Yes | — | Decision ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ownerID": {
"type": "string",
"description": "Owner ID"
},
"context": {
"type": "string",
"description": "The context value"
},
"decisionID": {
"type": "string",
"description": "Decision ID"
}
},
"required": [
"PCID",
"ownerID",
"context",
"decisionID"
]
}
circleci_admin_get_decision_logs
Retrieves the owner’s decision audit logs. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ownerID | string | Yes | — | Owner ID |
context | string | Yes | — | The context value |
status | string | No | — | Return decisions matching this decision status. |
after | string | No | — | Return decisions made after this date. |
before | string | No | — | Return decisions made before this date. |
branch | string | No | — | Return decisions made on this branch. |
project_id | string | No | — | Return decisions made for this project. |
build_number | string | No | — | Return decisions made for this build number. |
offset | integer | No | — | Sets the offset when retrieving the decisions, for paging. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ownerID": {
"type": "string",
"description": "Owner ID"
},
"context": {
"type": "string",
"description": "The context value"
},
"status": {
"type": "string",
"description": "Return decisions matching this decision status."
},
"after": {
"type": "string",
"description": "Return decisions made after this date."
},
"before": {
"type": "string",
"description": "Return decisions made before this date."
},
"branch": {
"type": "string",
"description": "Return decisions made on this branch."
},
"project_id": {
"type": "string",
"description": "Return decisions made for this project."
},
"build_number": {
"type": "string",
"description": "Return decisions made for this build number."
},
"offset": {
"type": "integer",
"description": "Sets the offset when retrieving the decisions, for paging."
}
},
"required": [
"PCID",
"ownerID",
"context"
]
}
circleci_admin_get_decision_settings
Get the decision settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ownerID | string | Yes | — | Owner ID |
context | string | Yes | — | The context value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ownerID": {
"type": "string",
"description": "Owner ID"
},
"context": {
"type": "string",
"description": "The context value"
}
},
"required": [
"PCID",
"ownerID",
"context"
]
}
circleci_admin_get_group
A group in an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | An opaque identifier of an organization. |
group_id | string | Yes | — | An opaque identifier of a group. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "An opaque identifier of an organization."
},
"group_id": {
"type": "string",
"description": "An opaque identifier of a group."
}
},
"required": [
"PCID",
"org_id",
"group_id"
]
}
circleci_admin_get_org_claims
Get org-level claims Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgID | string | Yes | — | Org ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"orgID": {
"type": "string",
"description": "Org ID"
}
},
"required": [
"PCID",
"orgID"
]
}
circleci_admin_get_organization
Get an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org-slug-or-id | string | Yes | — | Org UUID or slug in the form vcs-slug/org-name. For projects that use GitLab or GitHub App, use circleci as the vcs-slug and replace the org-name with the organization ID (found in Organization Settings). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org-slug-or-id": {
"type": "string",
"description": "Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)."
}
},
"required": [
"PCID",
"org-slug-or-id"
]
}
circleci_admin_get_organization_groups
Groups in an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org_id | string | Yes | — | An opaque identifier of an organization. |
limit | integer | No | — | The number of results per page. |
page-token | string | No | — | A token to specify which page of results to fetch. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org_id": {
"type": "string",
"description": "An opaque identifier of an organization."
},
"limit": {
"type": "integer",
"description": "The number of results per page."
},
"page-token": {
"type": "string",
"description": "A token to specify which page of results to fetch."
}
},
"required": [
"PCID",
"org_id"
]
}
circleci_admin_get_policy_bundle
Retrieves Policy Bundle Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ownerID | string | Yes | — | Owner ID |
context | string | Yes | — | The context value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ownerID": {
"type": "string",
"description": "Owner ID"
},
"context": {
"type": "string",
"description": "The context value"
}
},
"required": [
"PCID",
"ownerID",
"context"
]
}
circleci_admin_get_policy_document
Retrieves a policy document Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ownerID | string | Yes | — | Owner ID |
context | string | Yes | — | The context value |
policyName | string | Yes | — | the policy name set by the rego policy_name rule |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ownerID": {
"type": "string",
"description": "Owner ID"
},
"context": {
"type": "string",
"description": "The context value"
},
"policyName": {
"type": "string",
"description": "the policy name set by the rego policy_name rule"
}
},
"required": [
"PCID",
"ownerID",
"context",
"policyName"
]
}
circleci_admin_get_project_claims
Get project-level claims Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgID | string | Yes | — | Org ID |
projectID | string | Yes | — | Project ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"orgID": {
"type": "string",
"description": "Org ID"
},
"projectID": {
"type": "string",
"description": "Project ID"
}
},
"required": [
"PCID",
"orgID",
"projectID"
]
}
circleci_admin_get_user
User Information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The unique ID of the user. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The unique ID of the user."
}
},
"required": [
"PCID",
"id"
]
}
circleci_admin_get_webhook_by_id
Get a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook-id | string | Yes | — | ID of the webhook (UUID) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook-id": {
"type": "string",
"description": "ID of the webhook (UUID)"
}
},
"required": [
"PCID",
"webhook-id"
]
}
circleci_admin_get_webhooks
List webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
scope-id | string | Yes | — | ID of the scope being used (at the moment, only project ID is supported) |
scope-type | string | Yes | — | Type of the scope being used |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"scope-id": {
"type": "string",
"description": "ID of the scope being used (at the moment, only project ID is supported)"
},
"scope-type": {
"type": "string",
"description": "Type of the scope being used",
"enum": [
"project"
]
}
},
"required": [
"PCID",
"scope-id",
"scope-type"
]
}
circleci_admin_list_otel_exporters
🧪 List OTLP exporters Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org-id | string | Yes | — | An opaque identifier of an organization used in query parameters. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org-id": {
"type": "string",
"description": "An opaque identifier of an organization used in query parameters."
}
},
"required": [
"PCID",
"org-id"
]
}
circleci_admin_list_urlorb_allow_list_entries
List the entries in the org’s URL Orb allow-list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org-slug-or-id | string | Yes | — | Org UUID or slug in the form vcs-slug/org-name. For projects that use GitLab or GitHub App, use circleci as the vcs-slug and replace the org-name with the organization ID (found in Organization Settings). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org-slug-or-id": {
"type": "string",
"description": "Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)."
}
},
"required": [
"PCID",
"org-slug-or-id"
]
}
circleci_admin_make_decision
Makes a decision Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ownerID | string | Yes | — | Owner ID |
context | string | Yes | — | The context value |
input | string | Yes | — | The input value |
metadata | object | No | — | The metadata value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ownerID": {
"type": "string",
"description": "Owner ID"
},
"context": {
"type": "string",
"description": "The context value"
},
"input": {
"type": "string",
"description": "The input value"
},
"metadata": {
"type": "object",
"description": "The metadata value"
}
},
"required": [
"PCID",
"ownerID",
"context",
"input"
]
}
circleci_admin_patch_org_claims
Patch org-level claims Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgID | string | Yes | — | Org ID |
audience | string[] | No | — | The audience value |
ttl | string | No | — | The ttl value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"orgID": {
"type": "string",
"description": "Org ID"
},
"audience": {
"type": "array",
"items": {
"type": "string"
},
"description": "The audience value"
},
"ttl": {
"type": "string",
"description": "The ttl value"
}
},
"required": [
"PCID",
"orgID"
]
}
circleci_admin_patch_project_claims
Patch project-level claims Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orgID | string | Yes | — | Org ID |
projectID | string | Yes | — | Project ID |
audience | string[] | No | — | The audience value |
ttl | string | No | — | The ttl value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"orgID": {
"type": "string",
"description": "Org ID"
},
"projectID": {
"type": "string",
"description": "Project ID"
},
"audience": {
"type": "array",
"items": {
"type": "string"
},
"description": "The audience value"
},
"ttl": {
"type": "string",
"description": "The ttl value"
}
},
"required": [
"PCID",
"orgID",
"projectID"
]
}
circleci_admin_remove_urlorb_allow_list_entry
Remove an entry from the org’s URL orb allow-list Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
org-slug-or-id | string | Yes | — | Org UUID or slug in the form vcs-slug/org-name. For projects that use GitLab or GitHub App, use circleci as the vcs-slug and replace the org-name with the organization ID (found in Organization Settings). |
allow-list-entry-id | string | Yes | — | URL orb allow-list entry UUID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"org-slug-or-id": {
"type": "string",
"description": "Org UUID or slug in the form `vcs-slug/org-name`. For projects that use GitLab or GitHub App, use `circleci` as the `vcs-slug` and replace the `org-name` with the organization ID (found in Organization Settings)."
},
"allow-list-entry-id": {
"type": "string",
"description": "URL orb allow-list entry UUID."
}
},
"required": [
"PCID",
"org-slug-or-id",
"allow-list-entry-id"
]
}
circleci_admin_set_decision_settings
Set the decision settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ownerID | string | Yes | — | Owner ID |
context | string | Yes | — | The context value |
enabled | boolean | No | — | The enabled value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ownerID": {
"type": "string",
"description": "Owner ID"
},
"context": {
"type": "string",
"description": "The context value"
},
"enabled": {
"type": "boolean",
"description": "The enabled value"
}
},
"required": [
"PCID",
"ownerID",
"context"
]
}
circleci_admin_update_webhook
Update an outbound webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook-id | string | Yes | — | ID of the webhook (UUID) |
events | string[] | No | — | Events that will trigger the webhook |
name | string | No | — | Name of the webhook |
signing-secret | string | No | — | Secret used to build an HMAC hash of the payload and passed as a header in the webhook request |
url | string | No | — | URL to deliver the webhook to. Note: protocol must be included as well (only https is supported) |
verify-tls | boolean | No | — | Whether to enforce TLS certificate verification when delivering the webhook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook-id": {
"type": "string",
"description": "ID of the webhook (UUID)"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"workflow-completed",
"job-completed"
]
},
"description": "Events that will trigger the webhook"
},
"name": {
"type": "string",
"description": "Name of the webhook"
},
"signing-secret": {
"type": "string",
"description": "Secret used to build an HMAC hash of the payload and passed as a header in the webhook request"
},
"url": {
"type": "string",
"description": "URL to deliver the webhook to. Note: protocol must be included as well (only https is supported)"
},
"verify-tls": {
"type": "boolean",
"description": "Whether to enforce TLS certificate verification when delivering the webhook"
}
},
"required": [
"PCID",
"webhook-id"
]
}

