Skip to content

DELETE a group provided the group ID.

DELETE
/api/web/custom/namespaces/system/user_groups/{name}
curl --request DELETE \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/custom/namespaces/system/user_groups/example \
--header 'Authorization: <Authorization>'

DELETE deletes the group, provided the group ID and the users list association to the group It also deletes associated namespace roles for this user. Use this only if the user group and its referenced objects need to be wiped out altogether.

Examples of this operation.

name
required
string

Name of the user group name of the specific group.

attempt_remove_references
boolean format: boolean

X-example: true AttemptRemoveReferences ignores the AT/MT configuration references, and continue with the deletion of the group if set as true, else it will return all the references in the error. But some references like MSP configurations cannot be ignored.

A successful response.

Media typeapplication/json
Empty

Data for empty response.

object
Examplegenerated
{}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

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

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example