authentication.
Alle folgenden Aufrufe gehen an die Authentication-Management-API Ihrer Anwendung. MANAGEMENT_BASE lautet:
openapi-authentication.json unter dem Tag Setup beschrieben, aus der die Server-SDKs neu generiert werden.
Welche Zugangsdaten Sie verwenden sollten
Alle drei Zugangsmittel funktionieren, und jedes ist auf das beschränkt, was sein Inhaber genehmigt hat.
Diese Zugangsdaten werden auf jeder Konfigurationsroute mit
403 abgelehnt, unabhängig davon, was die Anfrage verlangt:
- Das primäre Geheimnis der Anwendung.
- Ein Token aus
POST /programmatic/login. Es wird für die Anwendung ausgestellt, nicht für die Console. - Ein Schlüssel ohne den Scope
authentication. Dazu gehört auch ein Schlüssel, der mit allen Ressourcen auf der höchsten Stufe erstellt wurde. Solche Schlüssel werden als Vollzugriff aufgeführt,scopesbleibt leer, und sie werden auf diesen Routen nicht akzeptiert. - Ein Schlüssel einer anderen Anwendung, eine Freigabe, die nur auf
didit:verificationbeschränkt ist, und eine Freigabe, die für eine andere Organisation genehmigt wurde.
401. Eine Freigabe oder ein Schlüssel behält zusätzlich die eigenen Grenzen: Die Freigabe gilt nur für ihre Scopes, Organisationen und die Rolle der Person, der Schlüssel nur für seine Scopes, seine IP-Allowlist und sein Ablaufdatum.
Zugriff genehmigen
Mit einem benannten API-Schlüssel
Öffnen Sie Developers -> API keys in der Business Console und erstellen Sie einen Schlüssel für die Anwendung, die Sie einrichten. Weisen Sie ihm die Ressourceauthentication mit Lesen oder Schreiben zu: Lesen umfasst alle Aufrufe, die das Setup lesen (GET). Schreiben umfasst alle Aufrufe, die es ändern (POST, PUT, PATCH, DELETE), und auch alle Leseaufrufe. Informationen zu Ablauf, IP-Allowlists und Rotation finden Sie unter API-Schlüssel. Ein Schlüssel gehört zu genau einer Anwendung und funktioniert nur für diese.
Über eine MCP-Verbindung
Ein Agent, der mit dem Didit-MCP-Server verbunden ist, verwendet die Berechtigung, die sein Eigentümer auf dem Zustimmungsbildschirm genehmigt hat, mitdidit:management. Siehe MCP-Authentifizierung.
Für Eigentümer ohne Passwort
Der Device-Code-Grant (RFC 8628) ermöglicht es einem Eigentümer, der sich mit Google, einem Passkey oder einem per E-Mail gesendeten Code anmeldet, denselben Zugriff von jedem Browser aus zu genehmigen, ohne ein Passwort einzugeben. Siehe Anmeldung ohne Browser.E-Mail-Code aktivieren
PUT methods/{name}/ akzeptiert enabled und sonst nichts für eine Methode, die keine Zugangsdaten benötigt.
credential_source: null. Methoden, die immer aktiv sind, lassen sich nicht deaktivieren: Diese Anfrage antwortet mit {"enabled": "always_on"}.
Google aktivieren
Eine Social-Methode benötigt die Zugangsdaten Ihrer eigenen OAuth-App oder die Test-App von Didit für eine Sandbox-Anwendung.Mit Ihrer eigenen Google-App
callback_uri aus der Antwort bei Ihrem Anbieter. Das Geheimnis ist nur schreibbar: Es wird von keiner Antwort zurückgegeben, und nur client_id lässt sich wieder auslesen. Wenn Sie eine Methode ohne Zugangsdaten aktivieren, obwohl zuvor keine gespeichert waren, lautet die Antwort {"credentials": "required"}.
Mit der Test-App von Didit (didit_test)
Eine Sandbox-Anwendung kann anstelle Ihrer eigenen Social-Apps die Social-Apps von Didit verwenden. Das reicht aus, um eine Einrichtung abzuschließen und ihre Funktion zu prüfen:
didit_test deckt Google, Microsoft, Apple und GitHub ab, und zwar nur für Sandbox-Anwendungen.
Ein
GET auf die Konfiguration nennt in didit_test_credentials die Anbieter, die eine Test-App für diese Anwendung bereitstellen kann. Bei einer Produktionsanwendung ist der Wert für alle vier Anbieter false.
Einrichtung auslesen
GET auf MANAGEMENT_BASE gibt die gesamte Einrichtung zurück: jede Methode mit enabled und credential_source sowie die Callback-URLs, die Sitzungsregeln und die Registrierungsrichtlinie.
GET zeigt, was aktiviert ist und was nicht. enabled auf oberster Ebene ist false, wenn die Authentifizierung für die Anwendung deaktiviert ist. Jede Änderung an der Einrichtung, die mit einer Verwaltungsberechtigung oder einem benannten API-Schlüssel vorgenommen wird, gibt dann 409 mit {"detail": "product_disabled"} zurück, und es wird nichts geschrieben. Kein Einrichtungsaufruf schaltet die Authentifizierung ein: Das muss eine Person für die Anwendung in der Business Console tun. Danach funktionieren Ihre Aufrufe.
Die übrige Einrichtung
Ein Grant oder ein Schlüssel erhält nur Zugriff auf die Einrichtung und deren Zähler, niemals auf Endbenutzerdaten. Für
users/, sessions/, sign-ins/, overview/, Kundenorganisationen, Rollen, Importe, Agenten-Sitzungen und Test-E-Mails ist weiterhin eine Konsolensitzung erforderlich.
Die Einstellung agent_humans_only gilt für die gesamte Anwendung. Nur ein Organisationsinhaber oder Administrator kann sie ändern. Ein benannter Schlüssel erhält 403 owner_or_admin_required. Wenn Sie die Einstellung aktivieren, ist außerdem ein registrierter Passkey erforderlich (passkey_required).