ListLoginProviders

accounts.list_login_providers() -> SyncLoginProvidersPage[LoginProvider]

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

token: Optional[str]

page_size: Optional[int]

maximum100

minimum0

filter: Optional[Filter]

filter contains the filter options for listing login methods

email: Optional[str]

email is the email address to filter SSO providers by

invite_id: Optional[str]

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

formatuuid

pagination: Optional[Pagination]

pagination contains the pagination options for listing login methods

token: Optional[str]

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

page_size: Optional[int]

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

formatint32

maximum100

ReturnsExpand Collapse

class LoginProvider: …

provider: str

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

login_url: Optional[str]

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

ListLoginProviders

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
page = client.accounts.list_login_providers(
    pagination={
        "page_size": 20
    },
)
page = page.login_providers[0]
print(page.provider)

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

Returns Examples

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