GetSSOLoginURL

client.Accounts.GetSSOLoginURL(ctx, body) (*AccountGetSSOLoginURLResponse, error)

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

body AccountGetSSOLoginURLParams

Email param.Field[string]

email is the email the user wants to login with

formatemail

ReturnTo param.Field[string]Optional

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

formaturi

ReturnsExpand Collapse

type AccountGetSSOLoginURLResponse struct{…}

LoginURL string

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

GetSSOLoginURL

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.Accounts.GetSSOLoginURL(context.TODO(), gitpod.AccountGetSSOLoginURLParams{
    Email: gitpod.F("user@company.com"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.LoginURL)
}

{
  "loginUrl": "loginUrl"
}

Returns Examples

{
  "loginUrl": "loginUrl"
}