ListLoginProviders

client.Accounts.ListLoginProviders(ctx, params) (*LoginProvidersPage[LoginProvider], error)

POST/gitpod.v1.AccountService/ListLoginProviders

Lists available login providers with optional filtering.

Use this method to:

View supported authentication methods
Get provider-specific login URLs
Filter providers by invite

Examples

List all providers:

Shows all available login providers.
```
pagination:
  pageSize: 20
```

List for specific invite:

Shows providers available for an invite.

filter:
  inviteId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
pagination:
  pageSize: 20

ParametersExpand Collapse

params AccountListLoginProvidersParams

Token param.Field[string]Optional

Query param

PageSize param.Field[int64]Optional

Query param

maximum100

minimum0

Filter param.Field[AccountListLoginProvidersParamsFilter]Optional

Body param: filter contains the filter options for listing login methods

Email stringOptional

email is the email address to filter SSO providers by

InviteID stringOptional

invite_id is the ID of the invite URL the user wants to login with

formatuuid

Pagination param.Field[AccountListLoginProvidersParamsPagination]Optional

Body param: pagination contains the pagination options for listing login methods

Token stringOptional

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

PageSize int64Optional

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

formatint32

maximum100

ReturnsExpand Collapse

type LoginProvider struct{…}

Provider string

provider is the provider used by this login method, e.g. “github”, “google”, “custom”

LoginURL stringOptional

login_url is the URL to redirect the browser agent to for login, when provider is “custom”

ListLoginProviders

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"),
  )
  page, err := client.Accounts.ListLoginProviders(context.TODO(), gitpod.AccountListLoginProvidersParams{
    Pagination: gitpod.F(gitpod.AccountListLoginProvidersParamsPagination{
      PageSize: gitpod.F(int64(20)),
    }),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "allowCustom": true,
  "loginProviders": [
    {
      "provider": "provider",
      "loginUrl": "loginUrl"
    }
  ]
}

Returns Examples

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "allowCustom": true,
  "loginProviders": [
    {
      "provider": "provider",
      "loginUrl": "loginUrl"
    }
  ]
}