DELETE

/api/v1/groups/{id}

Delete a group; profiles are moved or put in the trash, never permanently deleted

Request#

POSIX shell · curl

curl --fail-with-body --request DELETE \
  "$ADBR_API_URL/api/v1/groups/{id}" \
  -H "Authorization: Bearer $ADBR_API_TOKEN"

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs.

Authentication and permissions#

Authentication: Bearer token

Scopes: profiles:write

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

Parameter	Location	Required
`mode`	query	No
`target_group_id`	query	No
`id`	path	Yes

Complete parameter schemas

OpenAPI JSON

[
  {
    "schema": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "move_to_default"
          ]
        },
        {
          "type": "string",
          "enum": [
            "move_to_group"
          ]
        },
        {
          "type": "string",
          "enum": [
            "trash_profiles"
          ]
        }
      ]
    },
    "in": "query",
    "name": "mode",
    "required": false
  },
  {
    "schema": {
      "type": "string"
    },
    "in": "query",
    "name": "target_group_id",
    "required": false
  },
  {
    "schema": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "in": "path",
    "name": "id",
    "required": true
  }
]

Request body#

No request body declared.

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "moved",
          "trashed"
        ],
        "properties": {
          "moved": {
            "type": "integer"
          },
          "trashed": {
            "type": "integer"
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "Gruppe löschen; Profile werden verschoben oder in den Papierkorb gelegt, nie endgültig gelöscht",
  "tags": [
    "Gruppen"
  ],
  "parameters": [
    {
      "schema": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "move_to_default"
            ]
          },
          {
            "type": "string",
            "enum": [
              "move_to_group"
            ]
          },
          {
            "type": "string",
            "enum": [
              "trash_profiles"
            ]
          }
        ]
      },
      "in": "query",
      "name": "mode",
      "required": false
    },
    {
      "schema": {
        "type": "string"
      },
      "in": "query",
      "name": "target_group_id",
      "required": false
    },
    {
      "schema": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      },
      "in": "path",
      "name": "id",
      "required": true
    }
  ],
  "x-required-scopes": [
    "profiles:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "moved",
              "trashed"
            ],
            "properties": {
              "moved": {
                "type": "integer"
              },
              "trashed": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}