Skip to content
Ona API Reference
Ona Docs
API Reference
Accounts

DeleteAccount

client.accounts.delete(AccountDeleteParams { accountId, reason } body, RequestOptionsoptions?): AccountDeleteResponse
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
body: AccountDeleteParams { accountId, reason }
accountId: string
formatuuid
reason?: string | null

reason is an optional field for the reason for account deletion

maxLength256
ReturnsExpand Collapse
AccountDeleteResponse = unknown

DeleteAccount

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const account = await client.accounts.delete({ accountId: 'f53d2330-3795-4c5d-a1f3-453121af9c60' });

console.log(account);
{}
Returns Examples
{}