DeleteAccount

client.Accounts.Delete(ctx, body) (*AccountDeleteResponse, error)

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 param.Field[string]

formatuuid

Reason param.Field[string]Optional

reason is an optional field for the reason for account deletion

maxLength256

ReturnsExpand Collapse

type AccountDeleteResponse interface{…}

DeleteAccount

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"),
  )
  account, err := client.Accounts.Delete(context.TODO(), gitpod.AccountDeleteParams{
    AccountID: gitpod.F("f53d2330-3795-4c5d-a1f3-453121af9c60"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", account)
}

{}

Returns Examples

{}