ListSCMOrganizations

client.Runners.ListScmOrganizations(ctx, params) (*RunnerListScmOrganizationsResponse, error)

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"
```

ParametersExpand Collapse

params RunnerListScmOrganizationsParams

Token param.Field[string]Optional

Query param

PageSize param.Field[int64]Optional

Query param

maximum100

minimum0

RunnerID param.Field[string]Optional

Body param

formatuuid

ScmHost param.Field[string]Optional

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

minLength1

ReturnsExpand Collapse

type RunnerListScmOrganizationsResponse struct{…}

Organizations []RunnerListScmOrganizationsResponseOrganizationOptional

List of organizations the user belongs to

IsAdmin boolOptional

Whether the user has admin permissions in this organization. Admin permissions typically allow creating organization-level webhooks.

Name stringOptional

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

URL stringOptional

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

ListSCMOrganizations

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.Runners.ListScmOrganizations(context.TODO(), gitpod.RunnerListScmOrganizationsParams{
    RunnerID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"),
    ScmHost: gitpod.F("github.com"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Organizations)
}

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

Returns Examples

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