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

# Sicherheitsstatus des Benutzers abrufen

> Zeigt, welche Faktoren eingerichtet sind und ob eine Richtlinie einen zweiten Faktor vorschreibt. Auch mit einem Vorab-Token (`preAuthToken`) erreichbar.



## OpenAPI

````yaml /api-reference/openapi.json get /auth/security
openapi: 3.1.0
info:
  title: NETZFABRIK API
  description: >-
    REST-API der NETZFABRIK-Plattform für Domains, DNS, Cloud-Server, Webspaces,
    E-Mail-Dienste und Konto. Authentifizierung per JWT (Authorization: Bearer)
    oder API-Token (X-API-TOKEN).
  termsOfService: https://www.netzfabrik.com/tos
  contact:
    name: NETZFABRIK GmbH
    url: https://www.netzfabrik.com
    email: info@netzfabrik.com
  license:
    name: Proprietary
    url: https://www.netzfabrik.com/license
  version: 2026-11-19-9237c1a3
servers:
  - url: https://api.netzfabrik.com
security:
  - JWT: []
  - ApiToken: []
tags:
  - name: Login
  - name: Zwei-Faktor-Authentifizierung
  - name: Passkeys
  - name: Benutzer
  - name: Konten
  - name: Kunden
  - name: Verträge
  - name: Rechnungen
  - name: Support-Tickets
  - name: Domains
  - name: Domain-Bestellungen
  - name: Premium-Domains
  - name: Inhaberwechsel
  - name: Handles (Kontakte)
  - name: Handle-Verifizierung
  - name: TLD-Daten
  - name: Domain-Preise
  - name: Preislisten-Vorlagen
  - name: Preislisten-Versionen
  - name: Preis-Überschreibungen
  - name: Preisänderungen
  - name: Domain-Aktionen
  - name: Öffentliche Preislisten
  - name: Domain-Reseller
  - name: DNS-Zonen
  - name: DNS-Records
  - name: Weiterleitungen
  - name: Cloud-Server
  - name: Cloud-Server-Vorlagen
  - name: Regionen
  - name: SSH-Keys
  - name: ISO-Images
  - name: Anwendungen
  - name: Webspaces
  - name: Webspace-Tarife
  - name: Object Storage
  - name: E-Mail-Protection
  - name: E-Mail-Security
  - name: E-Mail-Archiv
  - name: Colocation
  - name: Racks
  - name: Stromzuführungen
  - name: Interconnections
  - name: VLANs
  - name: Traffic
paths:
  /auth/security:
    get:
      tags:
        - Zwei-Faktor-Authentifizierung
      summary: Sicherheitsstatus des Benutzers abrufen
      description: >-
        Zeigt, welche Faktoren eingerichtet sind und ob eine Richtlinie einen
        zweiten Faktor vorschreibt. Auch mit einem Vorab-Token (`preAuthToken`)
        erreichbar.
      operationId: getSecurityStatus
      parameters: []
      responses:
        '200':
          description: User resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User.SecurityStatusResponse'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
        '404':
          description: Not found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
components:
  schemas:
    User.SecurityStatusResponse:
      type: object
      description: >-
        The e-mail address is unique platform-wide (case-insensitive). This is
        enforced

        by a functional unique index on LOWER(email) created in

        migrations/Version20260706130000.php. Doctrine ORM 2.x cannot map
        expression

        indexes, so it lives as raw SQL there instead of as an
        #[ORM\UniqueConstraint].
      properties:
        totpEnabled:
          type: boolean
        enrolledAt:
          description: Zeitpunkt der Aktivierung (ISO 8601) oder null
          type:
            - string
            - 'null'
        recoveryCodesRemaining:
          type: integer
        recoveryCodesLow:
          description: true, sobald weniger als drei Codes übrig sind
          type: boolean
        setupEnabled:
          description: >-
            Darf für diese Brand ein zweiter Faktor eingerichtet werden? (Flag
            auth.mfa)
          type: boolean
        methods:
          description: verfügbare Verifikationsverfahren
          example:
            - totp
          type: array
          items:
            type: string
        passkeys:
          description: >-
            Registrierte Passkeys (id, name, rpId, aaguid, transports, backedUp,
            createdAt, lastUsedAt, locked)
          type: array
          items:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        passkeySetupEnabled:
          description: Dürfen neue Passkeys registriert werden? (Flag auth.passkeys)
          type: boolean
        currentRpId:
          description: >-
            Relying-Party-ID des aktuellen Hostnames — nur Passkeys mit dieser
            rpId sind hier nutzbar
          type:
            - string
            - 'null'
        policy:
          description: >-
            Geltende MFA-Pflicht: required (gilt sie für diesen Nutzer?), level
            (OPTIONAL|REQUIRED_FOR_ADMINS|REQUIRED), source
            (default|brand|customer|ancestor), graceUntil (ISO 8601 oder null),
            graceActive
          example:
            required: true
            level: REQUIRED
            source: ancestor
            graceUntil: '2026-09-21T08:00:00+00:00'
            graceActive: true
          type: array
          items:
            type:
              - string
              - 'null'
    Error:
      type: object
      description: A representation of common errors.
      properties:
        title:
          readOnly: true
          description: A short, human-readable summary of the problem.
          type:
            - string
            - 'null'
        detail:
          readOnly: true
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type:
            - string
            - 'null'
        status:
          type:
            - integer
            - 'null'
          examples:
            - 404
          default: 400
        instance:
          readOnly: true
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem. It may or may not yield further information if
            dereferenced.
          type:
            - string
            - 'null'
        type:
          readOnly: true
          description: A URI reference that identifies the problem type
          type: string
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access-Token aus `POST /auth/login` (E-Mail und Passwort), gesendet als
        `Authorization: Bearer <token>`.


        Das Token ist zeitlich begrenzt gültig. Mit dem `refresh_token` aus
        derselben Antwort holt `POST /auth/token/refresh` ein neues Token-Paar,
        ohne das Passwort erneut zu senden; `POST /auth/token/invalidate` macht
        den Refresh-Token beim Abmelden ungültig.


        Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert
        der Login statt des Token-Paars `mfaRequired: true` bzw.
        `mfaEnrollmentRequired: true` und ein kurzlebiges `preAuthToken`. Mit
        diesem Token (ebenfalls als Bearer) wird der zweite Faktor über `POST
        /auth/2fa/verify` bestätigt; erst danach gibt es das volle Token-Paar.
    ApiToken:
      type: apiKey
      in: header
      name: X-API-TOKEN
      description: >-
        Persönlicher API-Token für Skripte, CI/CD und
        Server-zu-Server-Integrationen, gesendet im Header `X-API-TOKEN:
        <token>`.


        Tokens werden im Kundenpanel unter **Einstellungen → Sicherheit**
        angelegt oder per `POST /user/api-tokens` mit einem gültigen JWT. Der
        Klartext erscheint nur einmal in der Antwort beim Anlegen. Ein Token
        handelt mit den Rechten des Benutzers, der ihn erstellt hat, kann ein
        Ablaufdatum haben und wird mit `DELETE /user/api-tokens/{id}` sofort
        widerrufen.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.