> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dados.rio/llms.txt
> Use this file to discover all available pages before exploring further.

# Delete a group

> Delete a group from the system with cascading cleanup.

**Authorization**: Users can delete groups they have permission to manage.
Permissions are checked via Cerbos policies.

**Cascade Effects**:
- Removes all group members
- Removes all role assignments from the group
- Updates Cerbos policies to reflect the group deletion

**Use Cases**:
- Remove obsolete or unused groups
- Administrative group cleanup
- System reorganization

**Safety**: Group deletion is irreversible. Ensure the group is no longer needed before deletion.



## OpenAPI

````yaml https://raw.githubusercontent.com/prefeitura-rio/heimdall/main/docs/api/openapi.json delete /api/v1/groups/{group_name}
openapi: 3.1.0
info:
  title: Heimdall Admin Service
  description: >-
    # Heimdall Admin Service API


    A comprehensive admin service for user and group management with
    authorization powered by Cerbos.


    ## Features


    - **User Management**: Automatic user creation from JWT tokens with
    role-based access control

    - **Group Management**: Create, manage, and assign users to groups with
    hierarchical permissions

    - **Role Management**: Define and assign roles to users and groups

    - **Mapping Management**: Configure API endpoint to action mappings for
    authorization

    - **Action Management**: Define available actions for fine-grained
    permission control

    - **Cerbos Integration**: Policy-based authorization with external Cerbos
    service

    - **Audit Logging**: Comprehensive audit trail for all administrative
    operations

    - **Redis Caching**: High-performance caching for frequently accessed data
  version: 1.0.0
servers:
  - url: https://services.pref.rio/heimdall-admin
    description: Production server
  - url: https://services.staging.app.dados.rio/heimdall-admin
    description: Staging server
security: []
tags:
  - name: health
    description: Service health and readiness checks
  - name: users
    description: >-
      User management operations. Users are automatically created from JWT
      tokens.
  - name: groups
    description: >-
      Group management operations. Groups organize users and can have roles
      assigned.
  - name: memberships
    description: Group membership management. Assign and remove users from groups.
  - name: roles
    description: >-
      Role management operations. Roles define permissions that can be assigned
      to users or groups.
  - name: actions
    description: >-
      Action management operations. Actions define the granular permissions
      available in the system.
  - name: mappings
    description: >-
      API endpoint to action mapping configuration. Maps HTTP endpoints to
      authorization actions.
paths:
  /api/v1/groups/{group_name}:
    delete:
      tags:
        - groups
      summary: Delete a group
      description: >-
        Delete a group from the system with cascading cleanup.


        **Authorization**: Users can delete groups they have permission to
        manage.

        Permissions are checked via Cerbos policies.


        **Cascade Effects**:

        - Removes all group members

        - Removes all role assignments from the group

        - Updates Cerbos policies to reflect the group deletion


        **Use Cases**:

        - Remove obsolete or unused groups

        - Administrative group cleanup

        - System reorganization


        **Safety**: Group deletion is irreversible. Ensure the group is no
        longer needed before deletion.
      operationId: delete_group_api_v1_groups__group_name__delete
      parameters:
        - name: group_name
          in: path
          required: true
          schema:
            type: string
            title: Group Name
      responses:
        '204':
          description: Group deleted successfully
        '401':
          description: Unauthorized - Invalid or missing JWT token
          content:
            application/json:
              example:
                error: Invalid authentication credentials
                status_code: 401
        '403':
          description: Forbidden - Insufficient permissions to delete group
          content:
            application/json:
              example:
                detail: Permission denied to delete group 'engineering_team'
        '404':
          description: Group not found
          content:
            application/json:
              example:
                detail: Group 'unknown-group' not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                detail: 'Failed to delete group: Database transaction error'
      security:
        - HTTPBearer: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````