Deletes an existing user

Auth

Deletes an existing user.

Path parameters

user_name string required

Identifier for the user

Responses

User successfully deleted

application/json

Response Type: object

  • The user cannot be deleted. (code: user.restricted_deletion)
  • External users cannot be modified. (code: user.cannot_modify_external)
  • Built-in users cannot be modified. (code: user.cannot_modify)
application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

User not found. (code: user.not_found)

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response