Skip to content
GitmoapAPIBeta
Integrateprovider-connections
GET/repositories/{repo_id}/provider-connections/{connection_id}

Get one of a repository's provider connections

get_repo_connection
  • provider_connection:read
    A token needs the provider_connection:read scope: View provider connectionsGranted by read_api, write_api.Every operation this scope unlocks
  • Audited · sensitive read

    x-gitmoap-audit: {"kind":"audited","arg":"sensitive_read"}

The connection's provider, name, how it authenticates, its configuration overrides and when its credentials were last rotated. Credential values are never returned, only references to where they are kept. Reporters and above, as members of the repository: a public repository does not make its connections readable.

Parameters

Path
  • repo_idRepositoryId (string · uuid)Repository id
  • connection_idConnectionId (string · uuid)Connection id

Responses

200application/json
  • auth_modeConnectionAuthModestatic_credentialsoidc_federationHow this connection authenticates.
  • created_atstring
  • created_byActorSummary
  • idConnectionId (string · uuid)
  • nameProviderConnectionName (string)
  • provider_idProviderId (string)
  • scope_idstring
  • scope_typeScopeTypegrouprepository
  • secret_refsobjectThe names of the stored credential fields, each with a reference to where it is stored. Never the values. Empty for an oidc_federation connection.
  • config_overridesobjectoptional
  • federation_targetOidcFederationTarget or nulloptionalThe cloud role the connection assumes. Present only when auth_mode is oidc_federation.
    • The OidcFederationTarget schema
    • cloudaws
    • role_arnRoleArn (string)The IAM role the pipeline assumes.
    • audiencestring or nulloptionalThe audience of the identity token. Defaults to sts.amazonaws.com.
    • regionAwsRegion (string) or nulloptionalThe AWS region for the provider's calls.
  • last_rotated_atstring or nulloptional
200 exampleSynthesized example
{
"auth_mode": "static_credentials",
"created_at": "2026-10-09T00:19:18Z",
"created_by": {
"email": "mara@acme.example",
"id": "id-2a79",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/d090c7b4"
},
"id": "04036457-0c20-4ddc-bd5f-d474a07f5f94",
"name": "payments-api",
"provider_id": "23071836-eb54-4c1f-9855-b4234aa2f794",
"scope_id": "dc2c0f22-93e8-4675-a9fa-fcc6ec82082d",
"scope_type": "group",
"secret_refs": {
"secret_refs": "secret-refs-beba"
},
"config_overrides": {},
"federation_target": {
"cloud": "aws",
"role_arn": "role-arn-6df7",
"audience": "audience-bd4a",
"region": "region-83fc"
},
"last_rotated_at": "2026-10-11T00:38:48Z"
}
400Bad request — a path parameter is not a well-formed value of its typeapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-21ce",
"message": "Pin a page's payload to the build that rendered it"
}
}
401application/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-c573",
"message": "Inline scalar newtypes but keep their brand"
}
}
403application/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-3899",
"message": "Pin a page's payload to the build that rendered it"
}
}
404application/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-cc09",
"message": "Label every synthesized example"
}
}

CLI

gitmoap provider-connections get-repo-connection

  • --repo-ididRepository id (id or owner/repo path)
  • --connection-ididConnection id

Used in these guides