Skip to content
Ona API Reference
Ona Docs
API Reference
Runners
Configurations
Scm Integrations

GetSCMIntegration

runners.configurations.scm_integrations.retrieve(ScmIntegrationRetrieveParams**kwargs) -> ScmIntegrationRetrieveResponse
POST/gitpod.v1.RunnerConfigurationService/GetSCMIntegration

Gets details about a specific SCM integration.

Use this method to:

  • View integration settings
  • Check integration status
  • Verify configuration

Examples

  • Get integration details:

    Retrieves information about a specific integration.

    id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ParametersExpand Collapse
id: Optional[str]
formatuuid
ReturnsExpand Collapse
class ScmIntegrationRetrieveResponse: …
integration: Optional[ScmIntegration]
id: Optional[str]

id is the unique identifier of the SCM integration

host: Optional[str]
oauth: Optional[ScmIntegrationOAuthConfig]
client_id: Optional[str]

client_id is the OAuth app’s client ID in clear text.

encrypted_client_secret: Optional[str]

encrypted_client_secret is the OAuth app’s secret encrypted with the runner’s public key.

formatbyte
issuer_url: Optional[str]

issuer_url is used to override the authentication provider URL, if it doesn’t match the SCM host.

+optional if not set, this account is owned by the installation.

pat: Optional[bool]
runner_id: Optional[str]
scm_id: Optional[str]

scm_id references the scm_id in the runner’s configuration schema that this integration is for

virtual_directory: Optional[str]

virtual_directory is the virtual directory path for Azure DevOps Server (e.g., “/tfs”). This field is only used for Azure DevOps Server SCM integrations and should be empty for other SCM types. Azure DevOps Server APIs work without collection when PAT scope is ‘All accessible organizations’.

GetSCMIntegration

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
scm_integration = client.runners.configurations.scm_integrations.retrieve(
    id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
)
print(scm_integration.integration)
{
  "integration": {
    "id": "id",
    "host": "host",
    "oauth": {
      "clientId": "clientId",
      "encryptedClientSecret": "U3RhaW5sZXNzIHJvY2tz",
      "issuerUrl": "issuerUrl"
    },
    "pat": true,
    "runnerId": "runnerId",
    "scmId": "scmId",
    "virtualDirectory": "virtualDirectory"
  }
}
Returns Examples
{
  "integration": {
    "id": "id",
    "host": "host",
    "oauth": {
      "clientId": "clientId",
      "encryptedClientSecret": "U3RhaW5sZXNzIHJvY2tz",
      "issuerUrl": "issuerUrl"
    },
    "pat": true,
    "runnerId": "runnerId",
    "scmId": "scmId",
    "virtualDirectory": "virtualDirectory"
  }
}