ListLoginProviders

client.accounts.listLoginProviders(, ?): LoginProvidersPage<LoginProvider { provider, loginUrl } >

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, pageSize, filter, pagination }

token?: string

Query param

pageSize?: number

Query param

maximum100

minimum0

filter?: Filter

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

email?: string | null

email is the email address to filter SSO providers by

inviteId?: string | null

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

formatuuid

pagination?: Pagination

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

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

ReturnsExpand Collapse

LoginProvider { provider, loginUrl }

provider: string

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

loginUrl?: string

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

ListLoginProviders

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 loginProvider of client.accounts.listLoginProviders({
  pagination: { pageSize: 20 },
})) {
  console.log(loginProvider.provider);
}

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

Returns Examples

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