Skip to content
Ona API Reference
Ona Docs
API Reference
Accounts

DeleteAccount

accounts.delete(AccountDeleteParams**kwargs) -> object
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"
ParametersExpand Collapse
account_id: str
formatuuid
reason: Optional[str]

reason is an optional field for the reason for account deletion

maxLength256
ReturnsExpand Collapse
object

DeleteAccount

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
account = client.accounts.delete(
    account_id="f53d2330-3795-4c5d-a1f3-453121af9c60",
)
print(account)
{}
Returns Examples
{}