OIDC Authentication

Exchange the ID token of a GitHub Actions job for a Mergify token, write the trust policies that allow it, and read the exchanges.


List the organization's trust policies Preview #

GET /ci/{owner}/oidc/trust-policies

Every trust policy of the organization. A CI job gets a Mergify CI token from its ID token when one of them matches it.

Application key permission: oidc_trust_policies: read.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

200 Successful Response
trust_policiesTrustPolicyResponse[]required
namestringrequired
min length: 1 · max length: 255
providerstringrequired
repositoriesobject (3 types)
Discriminated by mode — 3 types
allAllRepositories
modestringrequired

Every repository Mergify's GitHub App can access, new ones included as they are added.

all_exceptPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

onlyPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

conditionsGitHubActionsConditions-Output

The provider's own lines: for github_actions, the job's events, workflows and environments.

eventsstring | string[]

The job's event_name, or any.

workflowsstring | (OwnRepositoryWorkflow | ReusableWorkflow-Output)[]

The workflow the job runs, or any.

environmentsstring | string[]

The job's environment, or any, which includes a job that runs in none.

idstring <uuid>required
created_byActorrequired

Who wrote the policy.

type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
created_atstring <date-time>required
updated_byActor | nullrequired

Who last edited the policy, if anyone did.

type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
updated_atstring <date-time> | nullrequired
last_used_atstring <date-time> | nullrequired

When the policy last allowed a job, to the minute.

Example Response
                          {
  "trust_policies": [
    {
      "name": "string",
      "provider": "github_actions",
      "repositories": {},
      "conditions": {},
      "id": "string",
      "created_by": {},
      "created_at": "2024-01-15T09:00:00Z",
      "updated_by": {},
      "updated_at": "2024-01-15T09:00:00Z",
      "last_used_at": "2024-01-15T09:00:00Z"
    }
  ]
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 CI_ADMIN_ROLE_REQUIRED: Only organization admins and users with the CI Admin role can access this.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/ci/:owner/oidc/trust-policies" \
  -H "Authorization: Bearer <token>"

Create a trust policy Preview #

POST /ci/{owner}/oidc/trust-policies

Add a trust policy to the organization.

Application key permission: oidc_trust_policies: write.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

namestringrequired
min length: 1 · max length: 255
providerstringrequired
repositoriesobject (3 types)
Discriminated by mode — 3 types
allAllRepositories
modestringrequired

Every repository Mergify's GitHub App can access, new ones included as they are added.

all_exceptPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

onlyPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

conditionsGitHubActionsConditions-Input

The provider's own lines: for github_actions, the job's events, workflows and environments.

eventsstring | string[]

The job's event_name, or any.

workflowsstring | (OwnRepositoryWorkflow | ReusableWorkflow-Input)[]

The workflow the job runs, or any.

environmentsstring | string[]

The job's environment, or any, which includes a job that runs in none.

201 Successful Response
namestringrequired
min length: 1 · max length: 255
providerstringrequired
repositoriesobject (3 types)
Discriminated by mode — 3 types
allAllRepositories
modestringrequired

Every repository Mergify's GitHub App can access, new ones included as they are added.

all_exceptPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

onlyPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

conditionsGitHubActionsConditions-Output

The provider's own lines: for github_actions, the job's events, workflows and environments.

eventsstring | string[]

The job's event_name, or any.

workflowsstring | (OwnRepositoryWorkflow | ReusableWorkflow-Output)[]

The workflow the job runs, or any.

environmentsstring | string[]

The job's environment, or any, which includes a job that runs in none.

idstring <uuid>required
created_byActorrequired

Who wrote the policy.

type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
created_atstring <date-time>required
updated_byActor | nullrequired

Who last edited the policy, if anyone did.

type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
updated_atstring <date-time> | nullrequired
last_used_atstring <date-time> | nullrequired

When the policy last allowed a job, to the minute.

Example Response
                          {
  "name": "string",
  "provider": "github_actions",
  "repositories": {
    "mode": "all"
  },
  "conditions": {
    "events": "any",
    "workflows": "any",
    "environments": "any"
  },
  "id": "string",
  "created_by": {
    "type": "application",
    "id": 0,
    "name": "string"
  },
  "created_at": "2024-01-15T09:00:00Z",
  "updated_by": {
    "type": "application",
    "id": 0,
    "name": "string"
  },
  "updated_at": "2024-01-15T09:00:00Z",
  "last_used_at": "2024-01-15T09:00:00Z"
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 CI_ADMIN_ROLE_REQUIRED: Only organization admins and users with the CI Admin role can access this.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
404 Not found
409 CI_TRUST_POLICY_NAME_TAKEN: Another trust policy of the organization has this name.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
422 CI_TRUST_POLICY_LIMIT_REACHED: The organization has as many trust policies as an organization can have. Widen an existing policy, or delete one, instead. CI_TRUST_POLICY_REPOSITORY_UNKNOWN: The policy names a repository Mergify's GitHub App cannot access in the organization. Name repositories the app is installed on, by their GitHub id.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
Example Request
curl -X POST "https://api.mergify.com/v1/ci/:owner/oidc/trust-policies" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "provider": "github_actions",
  "repositories": {
    "mode": "all"
  },
  "conditions": {
    "events": "any",
    "workflows": "any",
    "environments": "any"
  }
}'

Get a trust policy Preview #

GET /ci/{owner}/oidc/trust-policies/{trust_policy_id}

One trust policy of the organization.

Application key permission: oidc_trust_policies: read.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
trust_policy_id string <uuid> required
owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

200 Successful Response
namestringrequired
min length: 1 · max length: 255
providerstringrequired
repositoriesobject (3 types)
Discriminated by mode — 3 types
allAllRepositories
modestringrequired

Every repository Mergify's GitHub App can access, new ones included as they are added.

all_exceptPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

onlyPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

conditionsGitHubActionsConditions-Output

The provider's own lines: for github_actions, the job's events, workflows and environments.

eventsstring | string[]

The job's event_name, or any.

workflowsstring | (OwnRepositoryWorkflow | ReusableWorkflow-Output)[]

The workflow the job runs, or any.

environmentsstring | string[]

The job's environment, or any, which includes a job that runs in none.

idstring <uuid>required
created_byActorrequired

Who wrote the policy.

type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
created_atstring <date-time>required
updated_byActor | nullrequired

Who last edited the policy, if anyone did.

type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
updated_atstring <date-time> | nullrequired
last_used_atstring <date-time> | nullrequired

When the policy last allowed a job, to the minute.

Example Response
                          {
  "name": "string",
  "provider": "github_actions",
  "repositories": {
    "mode": "all"
  },
  "conditions": {
    "events": "any",
    "workflows": "any",
    "environments": "any"
  },
  "id": "string",
  "created_by": {
    "type": "application",
    "id": 0,
    "name": "string"
  },
  "created_at": "2024-01-15T09:00:00Z",
  "updated_by": {
    "type": "application",
    "id": 0,
    "name": "string"
  },
  "updated_at": "2024-01-15T09:00:00Z",
  "last_used_at": "2024-01-15T09:00:00Z"
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 CI_ADMIN_ROLE_REQUIRED: Only organization admins and users with the CI Admin role can access this.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
404 CI_TRUST_POLICY_NOT_FOUND: The organization has no trust policy with this id.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/ci/:owner/oidc/trust-policies/:trust_policy_id" \
  -H "Authorization: Bearer <token>"

Update a trust policy Preview #

PATCH /ci/{owner}/oidc/trust-policies/{trust_policy_id}

Change what a trust policy matches. A field left out keeps its value, and so does a line of conditions left out.

Application key permission: oidc_trust_policies: write.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
trust_policy_id string <uuid> required
owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

namestring
min length: 1 · max length: 255
providerstring
repositoriesobject (3 types) | null

The repositories whose jobs it matches. null: every one.

Discriminated by mode — 3 types
allAllRepositories
modestringrequired

Every repository Mergify's GitHub App can access, new ones included as they are added.

all_exceptPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

onlyPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

conditionsGitHubActionsConditionsPatch | null

The provider's own lines: for github_actions, the job's events, workflows and environments. null puts back the default of each.

eventsstring | string[] | null

The job's event_name, or any. null: the CI events.

workflowsstring | (OwnRepositoryWorkflow | ReusableWorkflow-Input)[] | null

The workflow the job runs, or any. null: any.

environmentsstring | string[] | null

The job's environment, or any, which includes a job that runs in none. null: any.

200 Successful Response
namestringrequired
min length: 1 · max length: 255
providerstringrequired
repositoriesobject (3 types)
Discriminated by mode — 3 types
allAllRepositories
modestringrequired

Every repository Mergify's GitHub App can access, new ones included as they are added.

all_exceptPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

onlyPickedRepositories
mode"all_except" | "only"required

only the repositories listed, or all_except them, new ones included.

Enum: all_except only
idsinteger[]required

The ids of the repositories.

conditionsGitHubActionsConditions-Output

The provider's own lines: for github_actions, the job's events, workflows and environments.

eventsstring | string[]

The job's event_name, or any.

workflowsstring | (OwnRepositoryWorkflow | ReusableWorkflow-Output)[]

The workflow the job runs, or any.

environmentsstring | string[]

The job's environment, or any, which includes a job that runs in none.

idstring <uuid>required
created_byActorrequired

Who wrote the policy.

type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
created_atstring <date-time>required
updated_byActor | nullrequired

Who last edited the policy, if anyone did.

type"application" | "user"required
Enum: application user
idinteger | string <uuid>required
namestringrequired
updated_atstring <date-time> | nullrequired
last_used_atstring <date-time> | nullrequired

When the policy last allowed a job, to the minute.

Example Response
                          {
  "name": "string",
  "provider": "github_actions",
  "repositories": {
    "mode": "all"
  },
  "conditions": {
    "events": "any",
    "workflows": "any",
    "environments": "any"
  },
  "id": "string",
  "created_by": {
    "type": "application",
    "id": 0,
    "name": "string"
  },
  "created_at": "2024-01-15T09:00:00Z",
  "updated_by": {
    "type": "application",
    "id": 0,
    "name": "string"
  },
  "updated_at": "2024-01-15T09:00:00Z",
  "last_used_at": "2024-01-15T09:00:00Z"
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 CI_ADMIN_ROLE_REQUIRED: Only organization admins and users with the CI Admin role can access this.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
404 CI_TRUST_POLICY_NOT_FOUND: The organization has no trust policy with this id.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
409 CI_TRUST_POLICY_NAME_TAKEN: Another trust policy of the organization has this name.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
422 CI_TRUST_POLICY_REPOSITORY_UNKNOWN: The policy names a repository Mergify's GitHub App cannot access in the organization. Name repositories the app is installed on, by their GitHub id.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
Example Request
curl -X PATCH "https://api.mergify.com/v1/ci/:owner/oidc/trust-policies/:trust_policy_id" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "provider": "github_actions",
  "repositories": {
    "mode": "all"
  },
  "conditions": {
    "events": "any",
    "workflows": "any",
    "environments": "any"
  }
}'

Delete a trust policy Preview #

DELETE /ci/{owner}/oidc/trust-policies/{trust_policy_id}

Delete a trust policy. The jobs only it allowed get no token from then on, and the tokens already issued expire within the hour.

Application key permission: oidc_trust_policies: write.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
trust_policy_id string <uuid> required
owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

204 No content
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 CI_ADMIN_ROLE_REQUIRED: Only organization admins and users with the CI Admin role can access this.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
404 CI_TRUST_POLICY_NOT_FOUND: The organization has no trust policy with this id.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
409 Conflict
422 Unprocessable entity
Example Request
curl -X DELETE "https://api.mergify.com/v1/ci/:owner/oidc/trust-policies/:trust_policy_id" \
  -H "Authorization: Bearer <token>"

List the exchanges of the organization's CI jobs Preview #

GET /ci/{owner}/oidc/exchanges

Each time a CI job of the organization traded its ID token for a Mergify CI token, or tried to, latest first: the policies that allowed it, or the reason it was refused. A token whose signature does not verify, or that expired, is not listed: nothing in it can be trusted to name the organization.

Application key permission: oidc_trust_policies: read.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

cursor string

The opaque cursor of the current page. Must be extracted from RFC 5988 pagination links to get the previous/next pages

per_page integer

The number of items per page

min: 1 · max: 100

outcome "allowed" | "refused"

Only the allowed, or the refused, exchanges.

repository_id integer

Only the exchanges of this repository.

min: -9223372036854776000 · max: 9223372036854776000

allowed_by_policy_id string <uuid>

Only the exchanges this policy allowed.

start string <date-time>

Start of the time range: an ISO 8601 datetime with a UTC offset (e.g. 2024-01-01T00:00:00Z); a Unix timestamp or a datetime without an offset is refused. Defaults to end - 1 day when omitted; a paginated response carries the resolved value in its Link header.

end string <date-time>

End of the time range: an ISO 8601 datetime with a UTC offset (e.g. 2024-01-01T00:00:00Z); a Unix timestamp or a datetime without an offset is refused. Defaults to start + 1 day when only start is provided, or now otherwise; a paginated response carries the resolved value in its Link header.

200 Successful Response
sizeintegerrequired

The number of items in this page

per_pageintegerrequired

The number of items per page

exchangesExchange[]required
idstring <uuid>required
first_exchanged_atstring <date-time>required

When the first of the exchanges this row counts happened: the report is ordered and filtered by it.

last_exchanged_atstring <date-time>required

When the last of them happened.

countintegerrequired

The exchanges this row counts: those of the jobs of one run attempt that ran the same workflow, in the same environment, and got the same answer.

outcome"allowed" | "refused"required
Enum: allowed refused
repositoryExchangeRepositoryrequired
idintegerrequired
full_namestringrequired

As the job's ID token named it.

providerstringrequired

The CI provider that issued the job's ID token.

jobExchangeJobrequired

The job's claims, in its provider's terms: for github_actions, its run, event, ref, workflows and environment.

eventstringrequired
refstringrequired
workflow_refstring | nullrequired
job_workflow_refstring | nullrequired
environmentstring | nullrequired
run_idintegerrequired
run_attemptintegerrequired
allowed_by_policiesExchangePolicy[]required

The policies that allowed the job, of those that still exist: an exchange only policies deleted since allowed lists none.

idstring <uuid>required

The policy's id.

namestringrequired

The policy's current name.

allowed_by_policy_idsstring <uuid>[]required

Deprecated: the ids of allowed_by_policies.

refusalExchangeRefusal | nullrequired
reason"no_policy" | "no_matching_policy" | "repository_not_installed" | "audience_mismatch"required
Enum: no_policy no_matching_policy repository_not_installed audience_mismatch
policiesExchangeRefusedBy[]required

For no_matching_policy, why each policy did not match, of those that still exist.

idstring <uuid>required

The policy's id.

namestringrequired

The policy's current name.

line"repositories" | "events" | "workflows" | "environments"required

The policy's first line the job did not match, as the policy read when the job exchanged its token.

Enum: repositories events workflows environments
detailstringrequired
Example Response
                          {
  "size": 0,
  "per_page": 0,
  "exchanges": [
    {
      "id": "string",
      "first_exchanged_at": "2024-01-15T09:00:00Z",
      "last_exchanged_at": "2024-01-15T09:00:00Z",
      "count": 0,
      "outcome": "allowed",
      "repository": {},
      "provider": "github_actions",
      "job": {},
      "allowed_by_policies": null,
      "allowed_by_policy_ids": null,
      "refusal": {}
    }
  ]
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 CI_ADMIN_ROLE_REQUIRED: Only organization admins and users with the CI Admin role can access this.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/ci/:owner/oidc/exchanges" \
  -H "Authorization: Bearer <token>"

Count the exchanges of the organization's CI jobs Preview #

GET /ci/{owner}/oidc/exchanges/summary

How many exchanges the report lists for the same query were allowed and refused, from how many workflows the refused ones came, and how many each policy allowed. Each counts the jobs' exchanges, not the report's rows.

Application key permission: oidc_trust_policies: read.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

outcome "allowed" | "refused"

Only the allowed, or the refused, exchanges.

repository_id integer

Only the exchanges of this repository.

min: -9223372036854776000 · max: 9223372036854776000

allowed_by_policy_id string <uuid>

Only the exchanges this policy allowed.

start string <date-time>

Start of the time range: an ISO 8601 datetime with a UTC offset (e.g. 2024-01-01T00:00:00Z); a Unix timestamp or a datetime without an offset is refused. Defaults to end - 1 day when omitted; a paginated response carries the resolved value in its Link header.

end string <date-time>

End of the time range: an ISO 8601 datetime with a UTC offset (e.g. 2024-01-01T00:00:00Z); a Unix timestamp or a datetime without an offset is refused. Defaults to start + 1 day when only start is provided, or now otherwise; a paginated response carries the resolved value in its Link header.

200 Successful Response
allowedintegerrequired

The exchanges allowed.

refusedintegerrequired

The exchanges refused.

refused_workflowsintegerrequired

The workflows the refused exchanges came from: the workflow file each job's run ran, whatever its branch, a reusable workflow counting as the workflow that called it.

policiesPolicyExchanges[]required

The exchanges each policy of the organization allowed, for those that allowed any. An exchange several policies allowed counts for each; a policy deleted since is left out.

idstring <uuid>required

The policy's id.

namestringrequired

The policy's current name.

allowedintegerrequired

The exchanges it allowed.

Example Response
                          {
  "allowed": 0,
  "refused": 0,
  "refused_workflows": 0,
  "policies": [
    {
      "id": "string",
      "name": "string",
      "allowed": 0
    }
  ]
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 CI_ADMIN_ROLE_REQUIRED: Only organization admins and users with the CI Admin role can access this.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
404 Not found
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/ci/:owner/oidc/exchanges/summary" \
  -H "Authorization: Bearer <token>"

Get one exchange of the organization's CI jobs Preview #

GET /ci/{owner}/oidc/exchanges/{exchange_id}

One exchange of the report, by the id a refused job's log names.

Application key permission: oidc_trust_policies: read.

Application Key Admin Application Key Mergify User Token GitHub Token Deprecated
exchange_id string <uuid> required
owner string required

The owner of the repository

min length: 1 · max length: 40 · pattern: ^[a-zA-Z0-9\-]+$

200 Successful Response
idstring <uuid>required
first_exchanged_atstring <date-time>required

When the first of the exchanges this row counts happened: the report is ordered and filtered by it.

last_exchanged_atstring <date-time>required

When the last of them happened.

countintegerrequired

The exchanges this row counts: those of the jobs of one run attempt that ran the same workflow, in the same environment, and got the same answer.

outcome"allowed" | "refused"required
Enum: allowed refused
repositoryExchangeRepositoryrequired
idintegerrequired
full_namestringrequired

As the job's ID token named it.

providerstringrequired

The CI provider that issued the job's ID token.

jobExchangeJobrequired

The job's claims, in its provider's terms: for github_actions, its run, event, ref, workflows and environment.

eventstringrequired
refstringrequired
workflow_refstring | nullrequired
job_workflow_refstring | nullrequired
environmentstring | nullrequired
run_idintegerrequired
run_attemptintegerrequired
allowed_by_policiesExchangePolicy[]required

The policies that allowed the job, of those that still exist: an exchange only policies deleted since allowed lists none.

idstring <uuid>required

The policy's id.

namestringrequired

The policy's current name.

allowed_by_policy_idsstring <uuid>[]required

Deprecated: the ids of allowed_by_policies.

refusalExchangeRefusal | nullrequired
reason"no_policy" | "no_matching_policy" | "repository_not_installed" | "audience_mismatch"required
Enum: no_policy no_matching_policy repository_not_installed audience_mismatch
policiesExchangeRefusedBy[]required

For no_matching_policy, why each policy did not match, of those that still exist.

idstring <uuid>required

The policy's id.

namestringrequired

The policy's current name.

line"repositories" | "events" | "workflows" | "environments"required

The policy's first line the job did not match, as the policy read when the job exchanged its token.

Enum: repositories events workflows environments
detailstringrequired
Example Response
                          {
  "id": "string",
  "first_exchanged_at": "2024-01-15T09:00:00Z",
  "last_exchanged_at": "2024-01-15T09:00:00Z",
  "count": 0,
  "outcome": "allowed",
  "repository": {
    "id": 0,
    "full_name": "string"
  },
  "provider": "github_actions",
  "job": {
    "event": "string",
    "ref": "string",
    "workflow_ref": "string",
    "job_workflow_ref": "string",
    "environment": "string",
    "run_id": 0,
    "run_attempt": 0
  },
  "allowed_by_policies": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "allowed_by_policy_ids": [
    "string"
  ],
  "refusal": {
    "reason": "no_policy",
    "policies": [
      {}
    ]
  }
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 CI_ADMIN_ROLE_REQUIRED: Only organization admins and users with the CI Admin role can access this.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
404 CI_ID_TOKEN_EXCHANGE_NOT_FOUND: The report holds no such exchange for the caller: an id of no exchange of the organization, one past its retention, or one of a repository the caller cannot see.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
409 Conflict
422 Unprocessable entity
Example Request
curl -X GET "https://api.mergify.com/v1/ci/:owner/oidc/exchanges/:exchange_id" \
  -H "Authorization: Bearer <token>"

Exchange a CI job's ID token for a Mergify CI token Preview #

POST /ci/oidc/exchange

Verify the ID token GitHub Actions gave a job and answer a Mergify token valid for an hour, with the ci scope on the job's repository only.

id_tokenstringrequired

The ID token GitHub Actions gave the job.

min length: 1 · max length: 16384
200 Successful Response
tokenstringrequired
expires_inintegerrequired
Example Response
                          {
  "token": "string",
  "expires_in": 0
}
                        
400 API_VERSION_UNKNOWN: The Mergify-Version header names an API version this server does not serve. served_versions lists the versions it serves.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
served_versionsstring[]required
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string",
  "served_versions": [
    "string"
  ]
}
                        
403 CI_ID_TOKEN_EXCHANGE_NOT_ENABLED: The organization cannot authenticate its CI jobs with an ID token. CI_ID_TOKEN_INVALID: The ID token is malformed or its signature does not verify. CI_ID_TOKEN_ISSUER_REFUSED: The ID token comes from an issuer this Mergify does not trust. CI_ID_TOKEN_AUDIENCE_REFUSED: The ID token was issued for another audience than this Mergify API. CI_ID_TOKEN_EXPIRED: The ID token has expired. CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED: Mergify's installation on the organization does not cover the ID token's repository. CI_ID_TOKEN_NO_TRUST_POLICY: The organization has no trust policy, so it trusts no CI job. CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY: No trust policy of the organization matches the CI job.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
404 Not found
409 Conflict
422 Unprocessable entity
503 CI_ID_TOKEN_ISSUER_UNAVAILABLE: The ID token issuer's keys cannot be fetched; retrying later succeeds.
detailstringrequired
error_code"ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED" | "API_VERSION_UNKNOWN" | "APPLICATION_KEY_EXPIRED" | "APPLICATION_KEY_REFUSED" | "CI_ADMIN_ROLE_REQUIRED" | "CI_ID_TOKEN_AUDIENCE_REFUSED" | "CI_ID_TOKEN_EXCHANGE_NOT_ENABLED" | "CI_ID_TOKEN_EXCHANGE_NOT_FOUND" | "CI_ID_TOKEN_EXPIRED" | "CI_ID_TOKEN_INVALID" | "CI_ID_TOKEN_ISSUER_REFUSED" | "CI_ID_TOKEN_ISSUER_UNAVAILABLE" | "CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY" | "CI_ID_TOKEN_NO_TRUST_POLICY" | "CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED" | "CI_TOKEN_SCOPES_TARGET_REFUSED" | "CI_TRACES_UPLOAD_UNUSABLE" | "CI_TRUST_POLICY_LIMIT_REACHED" | "CI_TRUST_POLICY_NAME_TAKEN" | "CI_TRUST_POLICY_NOT_FOUND" | "CI_TRUST_POLICY_REPOSITORY_UNKNOWN" | "COMMAND_RESTRICTED" | "CONFIGURATION_BRANCH_REFUSED" | "CONFIGURATION_INVALID" | "CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE" | "CONFIGURATION_REFUSED_BY_REPOSITORY_RULES" | "CONFIGURATION_SIGNED_COMMITS_REQUIRED" | "DEFAULT_BRANCH_NOT_FOUND" | "FLAKY_DETECTION_NOT_CONFIGURED" | "GITHUB_ACCOUNT_SUSPENDED" | "GITHUB_APP_ACCESS_LOST" | "GITHUB_RATE_LIMITED" | "GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT" | "GITHUB_UPSTREAM_REQUEST_FORBIDDEN" | "GITHUB_UPSTREAM_REQUEST_REJECTED" | "GITHUB_UPSTREAM_UNAVAILABLE" | "ID_TOKEN_KEY_ROTATION_REFUSED" | "INTEGRATION_NOT_CONFIGURED" | "IP_ALLOW_LIST_NOT_CONFIGURED" | "KNOWN_TESTS_BEING_COMPUTED" | "KNOWN_TESTS_NOT_SERVED" | "MERGE_GATE_NOT_AVAILABLE" | "MERGE_GATE_UNREADABLE" | "MERGE_QUEUE_DISABLED" | "MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN" | "MERGE_QUEUE_SETTING_NOT_AVAILABLE" | "MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS" | "NO_LOGIN_IN_PROGRESS" | "ORGANIZATION_MEMBERS_ONLY" | "PIPELINES_NOT_ENABLED" | "PIPELINE_NAME_TAKEN" | "PIPELINE_NOT_FOUND" | "PIPELINE_RUN_NOT_ENDED" | "PIPELINE_RUN_NOT_FOUND" | "PIPELINE_RUN_PIPELINE_DELETED" | "PIPELINE_RUN_REPLACED" | "PIPELINE_RUN_RERUN_BY_STAFF_REFUSED" | "PIPELINE_RUN_SUPERSEDED" | "PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED" | "PIPELINE_SECRETS_KEY_ALREADY_ADDED" | "PIPELINE_SECRETS_KEY_IN_USE" | "PIPELINE_SECRETS_KEY_LIMIT_REACHED" | "PIPELINE_SECRETS_KEY_NOT_ACTIVE" | "PIPELINE_SECRETS_KEY_NOT_FOUND" | "PIPELINE_SECRETS_KEY_REPORTED" | "PIPELINE_SECRET_LIMIT_REACHED" | "PIPELINE_SECRET_NAME_TAKEN" | "PIPELINE_SECRET_NOT_FOUND" | "PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS" | "PIPELINE_SECRET_VERSION_CHANGED" | "PULL_REQUEST_ALREADY_QUEUED" | "PULL_REQUEST_LEAVING_QUEUE" | "PULL_REQUEST_NOT_FOUND" | "PULL_REQUEST_NOT_QUEUEABLE" | "PULL_REQUEST_NOT_QUEUED" | "PULL_REQUEST_QUEUE_REQUESTED" | "REPOSITORY_ADMIN_ROLE_REQUIRED" | "REPOSITORY_READ_ROLE_REQUIRED" | "REPOSITORY_WRITE_ROLE_REQUIRED" | "RETRY_RULE_NOT_FOUND" | "ROLE_ALREADY_GRANTED" | "ROLE_GRANTEE_REFUSED" | "ROLE_GRANT_NOT_FOUND" | "SAML_ENFORCEMENT_NOT_AUTHORIZED" | "SCHEDULED_FREEZE_NOT_FOUND" | "SCOPES_COVERAGE_GLOB_TOO_COSTLY" | "SCOPES_COVERAGE_MANUAL_SOURCE" | "SCOPES_COVERAGE_PATH_NOT_FOUND" | "SCOPES_COVERAGE_UNAVAILABLE" | "SETTING_MANAGED_BY_ENV" | "SETUP_ALREADY_DONE" | "SETUP_TOKEN_MISMATCH" | "STAFF_SESSION_REFUSED" | "STATISTICS_SCOPE_PERIOD_TOO_LARGE" | "SUBSCRIPTION_API_UNAVAILABLE" | "SUBSCRIPTION_FEATURE_REQUIRED" | "SUBSCRIPTION_INACTIVE" | "SUBSCRIPTION_TOKEN_INVALID" | "TEST_ALREADY_QUARANTINED" | "TEST_BRANCH_NOT_TRACKED" | "TEST_RESULTS_INGESTION_NOT_ENABLED" | "TEST_RETRY_NOT_CONFIGURED" | "TEST_STATE_NOT_FOUND" | "TEST_STATE_OVERLAP"
Enum: ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED API_VERSION_UNKNOWN APPLICATION_KEY_EXPIRED APPLICATION_KEY_REFUSED CI_ADMIN_ROLE_REQUIRED CI_ID_TOKEN_AUDIENCE_REFUSED CI_ID_TOKEN_EXCHANGE_NOT_ENABLED CI_ID_TOKEN_EXCHANGE_NOT_FOUND CI_ID_TOKEN_EXPIRED CI_ID_TOKEN_INVALID CI_ID_TOKEN_ISSUER_REFUSED CI_ID_TOKEN_ISSUER_UNAVAILABLE CI_ID_TOKEN_NO_MATCHING_TRUST_POLICY CI_ID_TOKEN_NO_TRUST_POLICY CI_ID_TOKEN_REPOSITORY_NOT_INSTALLED CI_TOKEN_SCOPES_TARGET_REFUSED CI_TRACES_UPLOAD_UNUSABLE CI_TRUST_POLICY_LIMIT_REACHED CI_TRUST_POLICY_NAME_TAKEN CI_TRUST_POLICY_NOT_FOUND CI_TRUST_POLICY_REPOSITORY_UNKNOWN COMMAND_RESTRICTED CONFIGURATION_BRANCH_REFUSED CONFIGURATION_INVALID CONFIGURATION_MIGRATION_CHOICES_UNAVAILABLE CONFIGURATION_REFUSED_BY_REPOSITORY_RULES CONFIGURATION_SIGNED_COMMITS_REQUIRED DEFAULT_BRANCH_NOT_FOUND FLAKY_DETECTION_NOT_CONFIGURED GITHUB_ACCOUNT_SUSPENDED GITHUB_APP_ACCESS_LOST GITHUB_RATE_LIMITED GITHUB_TWO_FACTOR_AUTHENTICATION_NONCOMPLIANT GITHUB_UPSTREAM_REQUEST_FORBIDDEN GITHUB_UPSTREAM_REQUEST_REJECTED GITHUB_UPSTREAM_UNAVAILABLE ID_TOKEN_KEY_ROTATION_REFUSED INTEGRATION_NOT_CONFIGURED IP_ALLOW_LIST_NOT_CONFIGURED KNOWN_TESTS_BEING_COMPUTED KNOWN_TESTS_NOT_SERVED MERGE_GATE_NOT_AVAILABLE MERGE_GATE_UNREADABLE MERGE_QUEUE_DISABLED MERGE_QUEUE_SETTING_INVALID_BRANCH_PATTERN MERGE_QUEUE_SETTING_NOT_AVAILABLE MERGE_QUEUE_SETTING_TOO_MANY_BRANCH_PATTERNS NO_LOGIN_IN_PROGRESS ORGANIZATION_MEMBERS_ONLY PIPELINES_NOT_ENABLED PIPELINE_NAME_TAKEN PIPELINE_NOT_FOUND PIPELINE_RUN_NOT_ENDED PIPELINE_RUN_NOT_FOUND PIPELINE_RUN_PIPELINE_DELETED PIPELINE_RUN_REPLACED PIPELINE_RUN_RERUN_BY_STAFF_REFUSED PIPELINE_RUN_SUPERSEDED PIPELINE_SECRETS_ACTIVE_KEYS_CHANGED PIPELINE_SECRETS_KEY_ALREADY_ADDED PIPELINE_SECRETS_KEY_IN_USE PIPELINE_SECRETS_KEY_LIMIT_REACHED PIPELINE_SECRETS_KEY_NOT_ACTIVE PIPELINE_SECRETS_KEY_NOT_FOUND PIPELINE_SECRETS_KEY_REPORTED PIPELINE_SECRET_LIMIT_REACHED PIPELINE_SECRET_NAME_TAKEN PIPELINE_SECRET_NOT_FOUND PIPELINE_SECRET_NOT_SEALED_TO_ACTIVE_KEYS PIPELINE_SECRET_VERSION_CHANGED PULL_REQUEST_ALREADY_QUEUED PULL_REQUEST_LEAVING_QUEUE PULL_REQUEST_NOT_FOUND PULL_REQUEST_NOT_QUEUEABLE PULL_REQUEST_NOT_QUEUED PULL_REQUEST_QUEUE_REQUESTED REPOSITORY_ADMIN_ROLE_REQUIRED REPOSITORY_READ_ROLE_REQUIRED REPOSITORY_WRITE_ROLE_REQUIRED RETRY_RULE_NOT_FOUND ROLE_ALREADY_GRANTED ROLE_GRANTEE_REFUSED ROLE_GRANT_NOT_FOUND SAML_ENFORCEMENT_NOT_AUTHORIZED SCHEDULED_FREEZE_NOT_FOUND SCOPES_COVERAGE_GLOB_TOO_COSTLY SCOPES_COVERAGE_MANUAL_SOURCE SCOPES_COVERAGE_PATH_NOT_FOUND SCOPES_COVERAGE_UNAVAILABLE SETTING_MANAGED_BY_ENV SETUP_ALREADY_DONE SETUP_TOKEN_MISMATCH STAFF_SESSION_REFUSED STATISTICS_SCOPE_PERIOD_TOO_LARGE SUBSCRIPTION_API_UNAVAILABLE SUBSCRIPTION_FEATURE_REQUIRED SUBSCRIPTION_INACTIVE SUBSCRIPTION_TOKEN_INVALID TEST_ALREADY_QUARANTINED TEST_BRANCH_NOT_TRACKED TEST_RESULTS_INGESTION_NOT_ENABLED TEST_RETRY_NOT_CONFIGURED TEST_STATE_NOT_FOUND TEST_STATE_OVERLAP
documentation_urlstring
Example Response
                          {
  "detail": "string",
  "error_code": "ACTIVITY_LOG_METADATA_FILTER_NOT_INDEXED",
  "documentation_url": "string"
}
                        
Example Request
curl -X POST "https://api.mergify.com/v1/ci/oidc/exchange" \
  -H "Content-Type: application/json" \
  -d '{
  "id_token": "string"
}'

Was this page helpful?