Skip to content
Ona API Reference
Ona Docs
API Reference
Accounts

GetSSOLoginURL

accounts.get_sso_login_url(AccountGetSSOLoginURLParams**kwargs) -> AccountGetSSOLoginURLResponse
POST/gitpod.v1.AccountService/GetSSOLoginURL

Gets the SSO login URL for a specific email domain.

Use this method to:

  • Initiate SSO authentication
  • Get organization-specific login URLs
  • Handle SSO redirects

Examples

  • Get login URL:

    Retrieves SSO URL for email domain.

    email: "user@company.com"

  • Get URL with return path:

    Gets SSO URL with specific return location.

    email: "user@company.com"
returnTo: "https://gitpod.io/workspaces"
ParametersExpand Collapse
email: str

email is the email the user wants to login with

formatemail
return_to: Optional[str]

return_to is the URL the user will be redirected to after login

formaturi
ReturnsExpand Collapse
class AccountGetSSOLoginURLResponse: …
login_url: str

login_url is the URL to redirect the user to for SSO login

GetSSOLoginURL

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
response = client.accounts.get_sso_login_url(
    email="user@company.com",
)
print(response.login_url)
{
  "loginUrl": "loginUrl"
}
Returns Examples
{
  "loginUrl": "loginUrl"
}