DELETE User and Related Objects.

POST

/api/web/custom/namespaces/{namespace}/users/cascade_delete

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/custom/namespaces/example/users/cascade_delete \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "namespace": "example" }'

• F5 Distributed Cloud Console

CascadeDelete deletes the user and associated namespace roles for this user. Use this only if the user and its referenced objects need to be wiped out altogether. Note: users will always be in the system namespace.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Value of namespace is always “system”

Request Body^required

Media typeapplication/json

CascadeDeleteRequest

CascadeDeleteRequest is the request to DELETE the user along with the associated namespace role objects. Note: only admin is allowed to DELETE the user and associated objects.

object

email

email of the user

Email of the user requesting for Required: YES.

string format: email

<= 1024 characters /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/

namespace

Namespace

Value of namespace is always “system”

string

>= 6 characters <= 1024 characters

Example^generated

{
  "email": "hello@example.com",
  "namespace": "example"
}

Responses

200

A successful response.

Media typeapplication/json

CascadeDeleteResponse

CascadeDeleteResponse contains a list of user objects that were deleted and possibly any errors when attempting to DELETE those objects.

object

delete_ok

delete_ok

Status of the deleted objects. “true” value indicates that the operation had been successful for all the objects. “false” value indicates that at least one of the DELETE operations had been unsuccessful.

boolean format: boolean

items

items

The objects deleted for the specific user.

Array<object>

CascadeDeleteItemType

CascadeDeleteItemType contains details of object that was handled as part of cascade DELETE of user and whether it was successfully deleted.

object

error_message

error message

Informative error message about the success or failure of the object’s deletion response.

string

<= 1024 characters

object_name

object's name

Name of the object.

string

<= 1024 characters

object_type

object's type

The type of the object.

string

<= 1024 characters

object_uid

object's uid

The uid of the object.

string

<= 1024 characters

Example^generated

{
  "delete_ok": true,
  "items": [
    {
      "error_message": "example",
      "object_name": "example",
      "object_type": "example",
      "object_uid": "example"
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example