GetSCMIntegration

client.runners.configurations.scmIntegrations.retrieve(, ?): ScmIntegrationRetrieveResponse { integration }

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

body: ScmIntegrationRetrieveParams { id }

id?: string

formatuuid

ReturnsExpand Collapse

ScmIntegrationRetrieveResponse { integration }

integration?: ScmIntegration { id, host, oauth, 4 more }

id?: string

id is the unique identifier of the SCM integration

host?: string

oauth?: ScmIntegrationOAuthConfig { clientId, encryptedClientSecret, issuerUrl } | null

clientId?: string

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

encryptedClientSecret?: string

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

formatbyte

issuerUrl?: string

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?: boolean

runnerId?: string

scmId?: string

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

virtualDirectory?: string | null

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 Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const scmIntegration = await client.runners.configurations.scmIntegrations.retrieve({
  id: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
});

console.log(scmIntegration.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"
  }
}