ListSCMOrganizations

client.runners.listScmOrganizations(, ?): OrganizationsPage<RunnerListScmOrganizationsResponse { isAdmin, name, url } >

POST/gitpod.v1.RunnerService/ListSCMOrganizations

Lists SCM organizations the user belongs to.

Use this method to:

Get all organizations for a user on a specific SCM host
Check organization admin permissions for webhook creation

Examples

List GitHub organizations:

Lists all organizations the user belongs to on GitHub.
```
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
scmHost: "github.com"
```

Search GitLab groups:

Returns the first page of GitLab groups matching the substring.

runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
scmHost: "gitlab.com"
query: "platform"
pagination:
  pageSize: 25

ParametersExpand Collapse

params: RunnerListScmOrganizationsParams { token, pageSize, pagination, 3 more }

token?: string

Query param

pageSize?: number

Query param

maximum100

minimum0

pagination?: Pagination

Body param: Pagination parameters. When unset, defaults to the standard PaginationRequest defaults (page_size 25, max 100). Tokens are opaque and provider-specific.

token?: string

Token for the next set of results that was returned as next_token of a PaginationResponse

pageSize?: number

Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.

formatint32

maximum100

query?: string

Body param: Optional substring filter applied to the organization name.

GitLab: forwarded to the upstream search parameter (server-side, case-insensitive substring on name/path).
GitHub and Bitbucket: not implemented as they don’t support searching Empty value means no filter.

runnerId?: string

Body param

formatuuid

scmHost?: string

Body param: The SCM host to list organizations from (e.g., “github.com”, “gitlab.com”)

minLength1

ReturnsExpand Collapse

RunnerListScmOrganizationsResponse { isAdmin, name, url }

DeprecatedisAdmin?: boolean

Deprecated: this field is unused by all known consumers and is scheduled for removal in a future release. Do not read it.

Originally intended to gate organization-level webhook creation in the dashboard, but that gating was never implemented. Populating this field on the GitLab path requires a second fully-paginated ListGroups call, which is the main reason we are deprecating it.

name?: string

Organization name/slug (e.g., “gitpod-io”)

url?: string

Organization URL (e.g., “https://github.com/gitpod-io”)

ListSCMOrganizations

import Gitpod from '@gitpod/sdk';

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

// Automatically fetches more pages as needed.
for await (const runnerListScmOrganizationsResponse of client.runners.listScmOrganizations({
  runnerId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
  scmHost: 'github.com',
})) {
  console.log(runnerListScmOrganizationsResponse.isAdmin);
}

{
  "organizations": [
    {
      "isAdmin": true,
      "name": "name",
      "url": "url"
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}

Returns Examples

{
  "organizations": [
    {
      "isAdmin": true,
      "name": "name",
      "url": "url"
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}