Deletes an existing user

DELETE /users/{user_name}
Basic auth Api key

Deletes an existing user.

Path parameters

  • user_name string Required

    Identifier for the user

Responses

  • 200 application/json

    User successfully deleted
  • 400 application/json
    • 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)
    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Values are user.restricted_deletion, user.cannot_modify_external, or user.cannot_modify.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • 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 array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
  • 404 application/json

    User not found. (code: user.not_found)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is user.not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • 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 array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
DELETE /users/{user_name} 
curl \
 --request DELETE 'https://{{hostname}}/api/v1/users/{user_name}' \
 --user "username:password"