Delete a user

DELETE 
/v1/users/:username

Permanently delete a user and all of their data. THIS CANNOT BE UNDONE

Request

Path Parameters

username stringrequired

Possible values: <= 255 characters

user within the organization to delete

Responses

200

Successful response

application/json

Schema

Schema

usernamestringrequired

Example (from schema)

{
  "username": "string"
}

400

Bad Request

application/json

Schema

Schema

messagestringrequired
The error message
Example: Bad Request
codestringrequired
The error code
Example: BAD_REQUEST

issues

object[]

An array of issues that were responsible for the error

Array [

messagestringrequired

]

Example (from schema)

{
  "code": "BAD_REQUEST",
  "message": "Bad Request",
  "issues": []
}

401

Invalid Credentials

application/json

Schema

Schema

messagestringrequired
The error message
Example: Invalid Credentials
codestringrequired
The error code
Example: UNAUTHORIZED

issues

object[]

An array of issues that were responsible for the error

Array [

messagestringrequired

]

Example (from schema)

{
  "code": "UNAUTHORIZED",
  "message": "Invalid Credentials",
  "issues": []
}

403

Unauthorized

application/json

Schema

Schema

messagestringrequired
The error message
Example: Unauthorized
codestringrequired
The error code
Example: FORBIDDEN

issues

object[]

An array of issues that were responsible for the error

Array [

messagestringrequired

]

Example (from schema)

{
  "code": "FORBIDDEN",
  "message": "Unauthorized",
  "issues": []
}

404

Not Found

application/json

Schema

Schema

messagestringrequired
The error message
Example: Not Found
codestringrequired
The error code
Example: NOT_FOUND

issues

object[]

An array of issues that were responsible for the error

Array [

messagestringrequired

]

Example (from schema)

{
  "code": "NOT_FOUND",
  "message": "Not Found",
  "issues": []
}

500

Internal Error

application/json

Schema

Schema

messagestringrequired
The error message
Example: Internal Error
codestringrequired
The error code
Example: INTERNAL_SERVER_ERROR

issues

object[]

An array of issues that were responsible for the error

Array [

messagestringrequired

]

Example (from schema)

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal Error",
  "issues": []
}