auth2faAPI-Referenz

POST/v2/auth2fa/list/passkey

Browser-Passkey registrieren

Verifiziert das vom Browser erzeugte Credential gegen die zuvor ausgestellte, einmalige ceremony und den aktuellen Konto-/Administrator-/Login-Kontext. Speichert nur den validierten öffentlichen Schlüssel; doppelte Credentials werden abgelehnt. label wird getrimmt und auf 100 Zeichen gekürzt. admin ist optional und darf nur die eigene öffentliche ID sein.

Operation-ID post_v2_auth2fa_list_passkey

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

Ressource: auth2fa · 2fa
Levels: 2, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Request Body

erforderlich

`application/json`

object

data object erforderlich

admin string

Öffentliche v2-ID aus dem gewählten Konto; keine rohe Datenbank-ID.

pattern: "^admin_[a-f0-9]{12}_-?[0-9]+$"

ceremony string erforderlich writeOnly sensibler Wert

Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

credential object erforderlich writeOnly sensibler Wert

WebAuthn PublicKeyCredential als JSON aus navigator.credentials.create(); Bibliothek prüft Attestation, Origin und Challenge.

id string

Base64URL-codierte Authenticator-Credential-Bytes; keine edoobox-Objekt- oder Datenbank-ID.

pattern: "^[A-Za-z0-9_-]+$"

Schema-Beispiel

"c3ludGhldGljLWNyZWRlbnRpYWw"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-id-kind": "webauthn-credential"
}

rawId string

type string

response object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

clientExtensionResults object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

label Typ nicht eingeschränkt

Kanonisch Text; serverseitig auf maximal 100 Zeichen gekürzt, Standard Passkey.

Schema-Beispiel

"Arbeitsgerät"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "admin": {
          "type": "string",
          "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus dem gewählten Konto; keine rohe Datenbank-ID."
        },
        "ceremony": {
          "type": "string",
          "writeOnly": true,
          "x-edoobox-sensitive": true,
          "description": "Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben."
        },
        "credential": {
          "type": "object",
          "additionalProperties": true,
          "description": "WebAuthn PublicKeyCredential als JSON aus navigator.credentials.create(); Bibliothek prüft Attestation, Origin und Challenge.",
          "x-edoobox-sensitive": true,
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^[A-Za-z0-9_-]+$",
              "x-edoobox-id-kind": "webauthn-credential",
              "description": "Base64URL-codierte Authenticator-Credential-Bytes; keine edoobox-Objekt- oder Datenbank-ID.",
              "examples": [
                "c3ludGhldGljLWNyZWRlbnRpYWw"
              ]
            },
            "rawId": {
              "type": "string"
            },
            "type": {
              "type": "string"
            },
            "response": {
              "type": "object",
              "additionalProperties": true
            },
            "clientExtensionResults": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "writeOnly": true
        },
        "label": {
          "description": "Kanonisch Text; serverseitig auf maximal 100 Zeichen gekürzt, Standard Passkey.",
          "examples": [
            "Arbeitsgerät"
          ]
        }
      },
      "additionalProperties": true,
      "required": [
        "ceremony",
        "credential"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

Browser-Passkey registrieren

{
  "data": {
    "ceremony": "synthetic-registration-ceremony",
    "label": "Arbeitsgerät",
    "credential": {
      "id": "c3ludGhldGljLWNyZWRlbnRpYWw",
      "rawId": "c3ludGhldGljLWNyZWRlbnRpYWw",
      "type": "public-key",
      "response": {
        "clientDataJSON": "c3ludGhldGlj",
        "attestationObject": "c3ludGhldGlj"
      }
    }
  }
}

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

Öffentliche Passkey-ID, Label und Unixzeitpunkte; kein privater Schlüssel.

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`application/json`

object

success boolean

error boolean | string

error_code string

data object

id string erforderlich

Öffentliche v2-ID aus dem gewählten Konto; keine rohe Datenbank-ID.

pattern: "^passkey_[a-f0-9]{12}_-?[0-9]+$"

label string erforderlich

date_create integer erforderlich

date_last_used integer erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^passkey_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus dem gewählten Konto; keine rohe Datenbank-ID."
        },
        "label": {
          "type": "string"
        },
        "date_create": {
          "type": "integer"
        },
        "date_last_used": {
          "type": "integer"
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "label",
        "date_create",
        "date_last_used"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "passkey_012345abcdef_123456",
    "label": "Arbeitsgerät",
    "date_create": 1790000000,
    "date_last_used": 0
  }
}

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40006"
}

401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40103"
}

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100"
}

403application/json

Permission denied. Browser CORS rejection may have an empty body.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40340"
}

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80019"
}

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80020"
}

429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

`Retry-After`

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "30"
  ]
}

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED42902"
}

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED50201"
}

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Auth2fa.php:188postAuth2fa()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

true

x-edoobox-sensitive-request-paths

[
  "/data/ceremony",
  "/data/credential"
]

x-edoobox-exampleStatus

"Requires a real browser-generated authenticator credential, user consent, and the matching ceremony. The synthetic example demonstrates wire shape only."

x-edoobox-runtime-preconditions

[
  "The deployment must install web-auth/webauthn-lib ^5.3 and its dependencies. Composer declaration alone does not establish an available runtime. A trusted configured client Origin and a real browser authenticator ceremony are additionally required."
]

x-edoobox-sensitiveResponseFields

[
  "otpauth",
  "yubikey",
  "qrcode",
  "review",
  "backupkey",
  "first5"
]

x-edoobox-account-security-mutation

true

x-edoobox-account-security-source

{
  "file": "application/models/v2/Auth2fa.php",
  "line": 184,
  "reason": "Authenticated account credential enrollment, recovery and deletion are account mutations. Preserve JWT tenant/current-role permissions and mutation approval. Enrollment/recovery material requires a protected human handoff; browser authenticator cryptography remains a human step."
}

x-edoobox-runtimeMutationGuard

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/05-auth.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Auth2fa.php",
  "method": "postAuth2fa",
  "line": 188,
  "branch": {
    "file": "application/models/v2/Auth2fa.php",
    "line": 206
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "auth2fa",
  "short": "2fa",
  "checkedByDispatcher": true,
  "levels": [
    2,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}

Vollständige Operation als JSON

{
  "operationId": "post_v2_auth2fa_list_passkey",
  "summary": "Browser-Passkey registrieren",
  "description": "Verifiziert das vom Browser erzeugte Credential gegen die zuvor ausgestellte, einmalige ceremony und den aktuellen Konto-/Administrator-/Login-Kontext. Speichert nur den validierten öffentlichen Schlüssel; doppelte Credentials werden abgelehnt. label wird getrimmt und auf 100 Zeichen gekürzt. admin ist optional und darf nur die eigene öffentliche ID sein.",
  "tags": [
    "auth2fa"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "Öffentliche Passkey-ID, Label und Unixzeitpunkte; kein privater Schlüssel.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "passkey_012345abcdef_123456",
              "label": "Arbeitsgerät",
              "date_create": 1790000000,
              "date_last_used": 0
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^passkey_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem gewählten Konto; keine rohe Datenbank-ID."
                  },
                  "label": {
                    "type": "string"
                  },
                  "date_create": {
                    "type": "integer"
                  },
                  "date_last_used": {
                    "type": "integer"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "label",
                  "date_create",
                  "date_last_used"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "admin": {
                  "type": "string",
                  "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus dem gewählten Konto; keine rohe Datenbank-ID."
                },
                "ceremony": {
                  "type": "string",
                  "writeOnly": true,
                  "x-edoobox-sensitive": true,
                  "description": "Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben."
                },
                "credential": {
                  "type": "object",
                  "additionalProperties": true,
                  "description": "WebAuthn PublicKeyCredential als JSON aus navigator.credentials.create(); Bibliothek prüft Attestation, Origin und Challenge.",
                  "x-edoobox-sensitive": true,
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^[A-Za-z0-9_-]+$",
                      "x-edoobox-id-kind": "webauthn-credential",
                      "description": "Base64URL-codierte Authenticator-Credential-Bytes; keine edoobox-Objekt- oder Datenbank-ID.",
                      "examples": [
                        "c3ludGhldGljLWNyZWRlbnRpYWw"
                      ]
                    },
                    "rawId": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    },
                    "response": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "clientExtensionResults": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  },
                  "writeOnly": true
                },
                "label": {
                  "description": "Kanonisch Text; serverseitig auf maximal 100 Zeichen gekürzt, Standard Passkey.",
                  "examples": [
                    "Arbeitsgerät"
                  ]
                }
              },
              "additionalProperties": true,
              "required": [
                "ceremony",
                "credential"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "Browser-Passkey registrieren",
            "value": {
              "data": {
                "ceremony": "synthetic-registration-ceremony",
                "label": "Arbeitsgerät",
                "credential": {
                  "id": "c3ludGhldGljLWNyZWRlbnRpYWw",
                  "rawId": "c3ludGhldGljLWNyZWRlbnRpYWw",
                  "type": "public-key",
                  "response": {
                    "clientDataJSON": "c3ludGhldGlj",
                    "attestationObject": "c3ludGhldGlj"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-sensitive-request-paths": [
    "/data/ceremony",
    "/data/credential"
  ],
  "x-edoobox-exampleStatus": "Requires a real browser-generated authenticator credential, user consent, and the matching ceremony. The synthetic example demonstrates wire shape only.",
  "x-edoobox-runtime-preconditions": [
    "The deployment must install web-auth/webauthn-lib ^5.3 and its dependencies. Composer declaration alone does not establish an available runtime. A trusted configured client Origin and a real browser authenticator ceremony are additionally required."
  ],
  "x-edoobox-sensitiveResponseFields": [
    "otpauth",
    "yubikey",
    "qrcode",
    "review",
    "backupkey",
    "first5"
  ],
  "x-edoobox-account-security-mutation": true,
  "x-edoobox-account-security-source": {
    "file": "application/models/v2/Auth2fa.php",
    "line": 184,
    "reason": "Authenticated account credential enrollment, recovery and deletion are account mutations. Preserve JWT tenant/current-role permissions and mutation approval. Enrollment/recovery material requires a protected human handoff; browser authenticator cryptography remains a human step."
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/05-auth.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Auth2fa.php",
    "method": "postAuth2fa",
    "line": 188,
    "branch": {
      "file": "application/models/v2/Auth2fa.php",
      "line": 206
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "auth2fa",
    "short": "2fa",
    "checkedByDispatcher": true,
    "levels": [
      2,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "ceremony": "synthetic-registration-ceremony",
    "label": "Arbeitsgerät",
    "credential": {
      "id": "c3ludGhldGljLWNyZWRlbnRpYWw",
      "rawId": "c3ludGhldGljLWNyZWRlbnRpYWw",
      "type": "public-key",
      "response": {
        "clientDataJSON": "c3ludGhldGlj",
        "attestationObject": "c3ludGhldGlj"
      }
    }
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/auth2fa/list/passkey' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/auth2fa/list/passkey";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "ceremony": "synthetic-registration-ceremony",
    "label": "Arbeitsgerät",
    "credential": {
      "id": "c3ludGhldGljLWNyZWRlbnRpYWw",
      "rawId": "c3ludGhldGljLWNyZWRlbnRpYWw",
      "type": "public-key",
      "response": {
        "clientDataJSON": "c3ludGhldGlj",
        "attestationObject": "c3ludGhldGlj"
      }
    }
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/auth2fa/list/passkey"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"ceremony\":\"synthetic-registration-ceremony\",\"label\":\"Arbeitsgerät\",\"credential\":{\"id\":\"c3ludGhldGljLWNyZWRlbnRpYWw\",\"rawId\":\"c3ludGhldGljLWNyZWRlbnRpYWw\",\"type\":\"public-key\",\"response\":{\"clientDataJSON\":\"c3ludGhldGlj\",\"attestationObject\":\"c3ludGhldGlj\"}}}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/auth2fa/list/passkey";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "ceremony": "synthetic-registration-ceremony",
    "label": "Arbeitsgerät",
    "credential": {
      "id": "c3ludGhldGljLWNyZWRlbnRpYWw",
      "rawId": "c3ludGhldGljLWNyZWRlbnRpYWw",
      "type": "public-key",
      "response": {
        "clientDataJSON": "c3ludGhldGlj",
        "attestationObject": "c3ludGhldGlj"
      }
    }
  }
});
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/auth2fa/list/passkey"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"ceremony\":\"synthetic-registration-ceremony\",\"label\":\"Arbeitsgerät\",\"credential\":{\"id\":\"c3ludGhldGljLWNyZWRlbnRpYWw\",\"rawId\":\"c3ludGhldGljLWNyZWRlbnRpYWw\",\"type\":\"public-key\",\"response\":{\"clientDataJSON\":\"c3ludGhldGlj\",\"attestationObject\":\"c3ludGhldGlj\"}}}}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.