LogoGitpod API Reference

Accounts

accounts

Methods

Delete Account -> unknown
post/gitpod.v1.AccountService/DeleteAccount

Deletes an account permanently.

Use this method to:

  • Remove unused accounts
  • Clean up test accounts
  • Complete account deletion requests

The account must not be an active member of any organization.

Examples

  • Delete account:

    Permanently removes an account.

    accountId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
Get SSO Login URL -> { loginUrl }
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: "[email protected]"

  • Get URL with return path:

    Gets SSO URL with specific return location.

    email: "[email protected]"
returnTo: "https://gitpod.io/workspaces"
List Login Providers -> LoginProvidersPage<
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
Get Account -> { account }
post/gitpod.v1.AccountService/GetAccount

Gets information about the currently authenticated account.

Use this method to:

  • Retrieve account profile information
  • Check organization memberships
  • View account settings
  • Get joinable organizations

Examples

  • Get account details:

    Retrieves information about the authenticated account.

    {}
Response fields
account:
Account
Request example
200Example

Domain types

Account = { id, createdAt, email, 7 more... }
AccountMembership = { organizationId, organizationName, userId, 2 more... }
JoinableOrganization = { organizationId, organizationName, organizationMemberCount }
LoginProvider = { provider, loginUrl }