Freigeben über


Passage von 1Password - Auth (Unabhängiger Herausgeber) (Vorschau)

Passage wird von 1Passwords 17+ Jahren branchenführender Sicherheitskompetenz unterstützt. Ersetzen Sie Ihren vorhandenen Authentifizierungsfluss oder Build von Grund auf durch eine robuste Lösung für kennwortlose Authentifizierung und Kundenidentitätsverwaltung. Realisieren Sie die vorteile der vollständigen Sicherheit, des Unternehmens und der Benutzererfahrung, indem Sie Anmeldeflüsse implementieren, die von Passkeys, magischen Links und Anmeldecodes unterstützt werden.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connectormetadaten
Herausgeber Troy Taylor
Webseite https://passage.1password.com/
Datenschutzrichtlinie https://storage.googleapis.com/passage-docs/passage-privacy-policy.pdf
Kategorien Sicherheit

Erstellen einer Verbindung

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.

Name Typ Description Erforderlich
API-Schlüssel (im Format "Bearer YOUR_API_KEY") securestring Der API-Schlüssel (im Format "Bearer YOUR_API_KEY") für diese API Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen der Metadaten des Benutzers

Rufen Sie die Benutzermetadaten für den aktuellen Benutzer ab.

Abrufen des aktuellen Benutzers

Rufen Sie Informationen zu einem Benutzer ab, der derzeit über das Bearertoken authentifiziert wird.

Abrufen von sozialen Verbindungen

Ruft soziale Verbindungen für den aktuellen Benutzer ab. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Aktualisieren der Metadaten des Benutzers

Aktualisiert die Metadaten für den aktuellen Benutzer. Nur gültige Metadatenfelder werden akzeptiert. Ungültige Metadatenfelder, die vorhanden sind, werden die Aktualisierung abgebrochen. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Aktualisierungstoken widerrufen

Widerruft das Aktualisierungstoken.

Anmelden mit magischem Link

Senden Sie eine Anmelde-E-Mail oder SMS an den Benutzer. Der Benutzer erhält eine E-Mail oder text mit einem Link, um seine Anmeldung abzuschließen.

Anmelden mit OTP

Senden Sie eine Anmelde-E-Mail oder SMS an den Benutzer. Der Benutzer erhält eine E-Mail oder text mit einer Einmalkennung, um seine Anmeldung abzuschließen.

App abrufen

Abrufen von Informationen zu einer Anwendung.

Authentifizieren eines magischen Links

Authentifiziert einen magischen Link für einen Benutzer. Dieser Endpunkt überprüft, ob der magische Link gültig ist, und gibt dann ein Authentifizierungstoken für den Benutzer zurück.

Authentifizieren von OTP

Authentifiziert eine einmalkennung für einen Benutzer. Dieser Endpunkt überprüft, ob die einmalkennung gültig ist, und gibt dann ein Authentifizierungstoken für den Benutzer zurück.

Beenden der WebAuthn-Registrierung

Schließt eine WebAuthn-Registrierung ab und authentifiziert den Benutzer.

Behandeln eines OAuth2-Rückrufs

Behandelt einen OAuth2-Ablaufrückruf.

Benutzer abrufen

Abrufen von Benutzerinformationen, wenn der Benutzer vorhanden ist. Dieser Endpunkt kann verwendet werden, um zu bestimmen, ob ein Benutzer über ein vorhandenes Konto verfügt und ob er sich anmelden oder registrieren soll.

Benutzer erstellen

Erstellen Sie einen Benutzer.

E-Mail ändern

Initiieren Sie eine E-Mail-Änderung für den authentifizierten Benutzer. Eine E-Mail-Änderung erfordert eine Überprüfung, sodass eine E-Mail an den Benutzer gesendet wird, den er überprüfen muss, bevor die E-Mail-Änderung wirksam wird.

Erstellen eines neuen Authentifizierungs- und Aktualisierungstokens

Erstellt und gibt ein neues Authentifizierungstoken und ein neues Aktualisierungstoken zurück.

Exchange OAuth2 für Authentifizierungstoken

Austausch von OAuth2-Verbindungsdaten für ein Authentifizierungstoken.

Fertigstellen des WebAuthn-Add-Geräts

Schließt einen WebAuthn-Add-Gerätevorgang für den aktuellen Benutzer ab. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Gerät aktualisieren

Aktualisiert ein Gerät anhand der ID für den aktuellen Benutzer. Derzeit ist das einzige Feld, das aktualisiert werden kann, der Anzeigename. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Gerät widerrufen

Widerrufen eines Geräts anhand der ID für den aktuellen Benutzer. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Geräte auflisten

Dient zum Abrufen einer Liste aller WebAuthn-Geräte für den authentifizierten Benutzer. Der Benutzer muss über das Bearertoken authentifiziert werden.

JWKS abrufen

Rufen Sie JWKS für eine App ab. KIDs im JWT können verwendet werden, um mit dem entsprechenden JWK übereinzugleichen und den öffentlichen Schlüssel des JWK zu verwenden, um das JWT zu überprüfen.

Löschen der sozialen Verbindung

Löscht eine soziale Verbindung für den aktuellen Benutzer. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Magischer Linkstatus

Überprüfen Sie, ob ein magischer Link noch aktiviert wurde oder nicht. Sobald die magische Verknüpfung aktiviert wurde, gibt dieser Endpunkt ein Authentifizierungstoken für den Benutzer zurück. Dieser Endpunkt kann verwendet werden, um eine Anmeldung auf einem Gerät zu initiieren und dann abzufragen und zu warten, bis die Anmeldung auf einem anderen Gerät abgeschlossen ist.

Mit magischem Link registrieren

Erstellen Sie einen Benutzer, und senden Sie dem Benutzer eine Registrierungs-E-Mail oder SMS. Der Benutzer erhält eine E-Mail oder text mit einem Link, um seine Registrierung abzuschließen.

OAuth2-Ablauf starten

Startet einen OAuth2-Fluss mit Anforderungsparametern des Verbindungsanbieters, die in https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest

OpenID-Konfiguration abrufen

Rufen Sie die OpenID-Konfiguration für eine App ab.

Registrieren bei OTP

Erstellen Sie einen Benutzer, und senden Sie dem Benutzer eine Registrierungs-E-Mail oder SMS. Der Benutzer erhält eine E-Mail oder text mit einer Einmalkennung, um die Registrierung abzuschließen.

Starten der WebAuthn-Registrierung

Initiieren Sie eine WebAuthn-Registrierung, und erstellen Sie den Benutzer. Dieser Endpunkt erstellt eine WebAuthn-Anmeldeinformationserstellungsabfrage, die zum Durchführen der Registrierungszeremonie aus dem Browser verwendet wird.

Starten des WebAuthn-Add-Geräts

Initiieren Eines WebAuthn-Add-Gerätevorgangs für den aktuellen Benutzer. Dieser Endpunkt erstellt eine WebAuthn-Anmeldeinformationserstellungsabfrage, die zum Durchführen der Registrierungszeremonie aus dem Browser verwendet wird. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Telefon ändern

Initiieren sie eine Änderung der Telefonnummer für den authentifizierten Benutzer. Eine Änderung einer Telefonnummer erfordert eine Überprüfung, sodass eine SMS mit einem Link an den Benutzer gesendet wird, den er überprüfen muss, bevor die Änderung der Telefonnummer wirksam wird.

Verknüpfen eines Kontos mit einer Verbindung

Verknüpft ein vorhandenes Konto mit einer OAuth2-Verbindung.

WebAuthn-Anmeldung abschließen

Schließt eine WebAuthn-Anmeldung ab und authentifiziert den Benutzer.

WebAuthn-Anmeldung starten

Initiieren sie eine WebAuthn-Anmeldung für einen Benutzer. Dieser Endpunkt erstellt eine Anforderung zur Assertion von WebAuthn-Anmeldeinformationen, die zum Ausführen der Anmeldezeremonie aus dem Browser verwendet wird.

Abrufen der Metadaten des Benutzers

Rufen Sie die Benutzermetadaten für den aktuellen Benutzer ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Gibt zurück

Abrufen des aktuellen Benutzers

Rufen Sie Informationen zu einem Benutzer ab, der derzeit über das Bearertoken authentifiziert wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Gibt zurück

Abrufen von sozialen Verbindungen

Ruft soziale Verbindungen für den aktuellen Benutzer ab. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Gibt zurück

Aktualisieren der Metadaten des Benutzers

Aktualisiert die Metadaten für den aktuellen Benutzer. Nur gültige Metadatenfelder werden akzeptiert. Ungültige Metadatenfelder, die vorhanden sind, werden die Aktualisierung abgebrochen. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Gibt zurück

Aktualisierungstoken widerrufen

Widerruft das Aktualisierungstoken.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Aktualisierungstoken
refresh_token True string

Aktualisierungstoken.

Senden Sie eine Anmelde-E-Mail oder SMS an den Benutzer. Der Benutzer erhält eine E-Mail oder text mit einem Link, um seine Anmeldung abzuschließen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

ID
identifier True string

Gültige E-Mail- oder E164-Telefonnummer.

Language
language string

Sprache der zu sendenden E-Mail oder SMS (optional).

Magic Link Path
magic_link_path string

Pfad relativ zum auth_origin der App (optional).

Gibt zurück

Anmelden mit OTP

Senden Sie eine Anmelde-E-Mail oder SMS an den Benutzer. Der Benutzer erhält eine E-Mail oder text mit einer Einmalkennung, um seine Anmeldung abzuschließen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

ID
identifier True string

Gültige E-Mail- oder E164-Telefonnummer.

Language
language string

Sprache der zu sendenden E-Mail (optional).

Gibt zurück

App abrufen

Abrufen von Informationen zu einer Anwendung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Gibt zurück

Authentifiziert einen magischen Link für einen Benutzer. Dieser Endpunkt überprüft, ob der magische Link gültig ist, und gibt dann ein Authentifizierungstoken für den Benutzer zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Magischer Link
magic_link True string

Die magische Verbindung.

Gibt zurück

Authentifizieren von OTP

Authentifiziert eine einmalkennung für einen Benutzer. Dieser Endpunkt überprüft, ob die einmalkennung gültig ist, und gibt dann ein Authentifizierungstoken für den Benutzer zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

OTP
otp True string

Die Einmalkennung.

OTP-ID
otp_id True string

Die ID der einmalkennung.

Gibt zurück

Beenden der WebAuthn-Registrierung

Schließt eine WebAuthn-Registrierung ab und authentifiziert den Benutzer.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Handshake-ID
handshake_id True string

Der Handshake-Bezeichner.

Authenticator-Anlage
authenticatorAttachment string

Die Authentifikatoranlage.

ID
id string

Der Bezeichner der Anmeldeinformationen. Die Anforderungen für den Bezeichner unterscheiden sich für jeden Anmeldeinformationstyp. Es kann z. B. einen Benutzernamen für Benutzernamen-/Kennwort-Tupel darstellen.

Roh-ID
rawId string

Der unformatierte Bezeichner.

Attestation-Objekt
attestationObject string

Das Attestation-Objekt ist die Bytesegmentversion von attestationObject. Dieses Attribut enthält ein Nachweisobjekt, das undurchsichtig ist und kryptografisch vor Manipulationen durch den Client geschützt ist. Das Attestation-Objekt enthält sowohl Authentifikatordaten als auch eine Attestationsanweisung. Der frühere enthält die AAGUID, eine eindeutige Anmeldeinformations-ID und den öffentlichen Schlüssel der Anmeldeinformationen. Der Inhalt der Attestationsanweisung wird durch das vom Authentifikator verwendete Attestationsanweisungsformat bestimmt. Sie enthält auch alle zusätzlichen Informationen, die der Server der vertrauenden Seite benötigt, um die Bescheinigungsanweisung zu überprüfen sowie die Authentifikatordaten zusammen mit den JSON-serialisierten Clientdaten zu decodieren und zu validieren.

JSON-Clientdaten
clientDataJSON string

Dieses Attribut enthält eine JSON-Serialisierung der Clientdaten, die vom Client im Aufruf von create() oder get() an den Authentifikator übergeben werden.

Transporte
transports array of string

Die Transporte.

Transporte
transports array of string

Die Transporte.

Typ
type string

Der Wert des [[type]]-Steckplatzes des Objektschnittstellenobjekts, der den durch dieses Objekt dargestellten Anmeldeinformationstyp angibt. Dies sollte "public-key" für Webauthn-Anmeldeinformationen sein.

Benutzer-ID
user_id True string

Der Benutzerbezeichner.

Gibt zurück

Behandeln eines OAuth2-Rückrufs

Behandelt einen OAuth2-Ablaufrückruf.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

OAuth2-Code
code True string

Der vom OAuth2-Anbieter zurückgegebene Autorisierungscode.

Staat
state string

Der vom OAuth2-Anbieter zurückgegebene Zustand.

Fehler
error string

Der vom OAuth2-Anbieter zurückgegebene Fehler.

Fehler
error_description string

Die vom OAuth2-Anbieter zurückgegebene Fehlerbeschreibung.

Benutzer abrufen

Abrufen von Benutzerinformationen, wenn der Benutzer vorhanden ist. Dieser Endpunkt kann verwendet werden, um zu bestimmen, ob ein Benutzer über ein vorhandenes Konto verfügt und ob er sich anmelden oder registrieren soll.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

E-Mail oder Telefon
identifier True string

E-Mail oder Telefonnummer.

Gibt zurück

Benutzer erstellen

Erstellen Sie einen Benutzer.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

ID
identifier True string

Der Bezeichner.

Gibt zurück

E-Mail ändern

Initiieren Sie eine E-Mail-Änderung für den authentifizierten Benutzer. Eine E-Mail-Änderung erfordert eine Überprüfung, sodass eine E-Mail an den Benutzer gesendet wird, den er überprüfen muss, bevor die E-Mail-Änderung wirksam wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Language
language string

Die Sprache der zu sendenden E-Mail (optional).

Magic Link Path
magic_link_path string

Der magische Linkpfad.

Neue E-Mail
new_email True string

Die neue E-Mail.

Umleitungs-URL
redirect_url string

Die Umleitungs-URL-Adresse.

Gibt zurück

Erstellen eines neuen Authentifizierungs- und Aktualisierungstokens

Erstellt und gibt ein neues Authentifizierungstoken und ein neues Aktualisierungstoken zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Aktualisierungstoken
refresh_token True string

Das Aktualisierungstoken.

Gibt zurück

Exchange OAuth2 für Authentifizierungstoken

Austausch von OAuth2-Verbindungsdaten für ein Authentifizierungstoken.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

OAuth2-Code
code True string

Der von der OAuth2-Umleitung angegebene Code.

Überprüfung
verifier True string

Der Prüfer, den der Client ursprünglich an den OAuth2-Anbieter gesendet hat.

Gibt zurück

Fertigstellen des WebAuthn-Add-Geräts

Schließt einen WebAuthn-Add-Gerätevorgang für den aktuellen Benutzer ab. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Handshake-ID
handshake_id True string

Der Handshake-Bezeichner.

Authenticator-Anlage
authenticatorAttachment string

Die Authentifikatoranlage.

ID
id string

Der Bezeichner der Anmeldeinformationen. Die Anforderungen für den Bezeichner unterscheiden sich für jeden Anmeldeinformationstyp. Es kann z. B. einen Benutzernamen für Benutzernamen-/Kennwort-Tupel darstellen.

Roh-ID
rawId string

Der unformatierte Bezeichner.

Attestation-Objekt
attestationObject string

Das Attestation-Objekt ist die Bytesegmentversion von attestationObject. Dieses Attribut enthält ein Nachweisobjekt, das undurchsichtig ist und kryptografisch vor Manipulationen durch den Client geschützt ist. Das Attestation-Objekt enthält sowohl Authentifikatordaten als auch eine Attestationsanweisung. Der frühere enthält die AAGUID, eine eindeutige Anmeldeinformations-ID und den öffentlichen Schlüssel der Anmeldeinformationen. Der Inhalt der Attestationsanweisung wird durch das vom Authentifikator verwendete Attestationsanweisungsformat bestimmt. Sie enthält auch alle zusätzlichen Informationen, die der Server der vertrauenden Seite benötigt, um die Bescheinigungsanweisung zu überprüfen sowie die Authentifikatordaten zusammen mit den JSON-serialisierten Clientdaten zu decodieren und zu validieren.

JSON-Clientdaten
clientDataJSON string

Dieses Attribut enthält eine JSON-Serialisierung der Clientdaten, die vom Client im Aufruf von create() oder get() an den Authentifikator übergeben werden.

Transporte
transports array of string

Die Transporte.

Transporte
transports array of string

Die Transporte.

Typ
type string

Der Wert des [[type]]-Steckplatzes des Objektschnittstellenobjekts, der den durch dieses Objekt dargestellten Anmeldeinformationstyp angibt. Dies sollte "public-key" für Webauthn-Anmeldeinformationen sein.

Benutzer-ID
user_id True string

Der Benutzerbezeichner.

Gibt zurück

Gerät aktualisieren

Aktualisiert ein Gerät anhand der ID für den aktuellen Benutzer. Derzeit ist das einzige Feld, das aktualisiert werden kann, der Anzeigename. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Geräte-ID
device_id True string

Geräte-ID.

Freundlicher Name
friendly_name True string

Der Anzeigename.

Gibt zurück

Gerät widerrufen

Widerrufen eines Geräts anhand der ID für den aktuellen Benutzer. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Geräte-ID
device_id True string

Geräte-ID.

Geräte auflisten

Dient zum Abrufen einer Liste aller WebAuthn-Geräte für den authentifizierten Benutzer. Der Benutzer muss über das Bearertoken authentifiziert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Gibt zurück

JWKS abrufen

Rufen Sie JWKS für eine App ab. KIDs im JWT können verwendet werden, um mit dem entsprechenden JWK übereinzugleichen und den öffentlichen Schlüssel des JWK zu verwenden, um das JWT zu überprüfen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Gibt zurück

Löschen der sozialen Verbindung

Löscht eine soziale Verbindung für den aktuellen Benutzer. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Verbindungstyp für soziale Netzwerke
social_connection_type True string

Der Typ der sozialen Verbindung.

Magischer Linkstatus

Überprüfen Sie, ob ein magischer Link noch aktiviert wurde oder nicht. Sobald die magische Verknüpfung aktiviert wurde, gibt dieser Endpunkt ein Authentifizierungstoken für den Benutzer zurück. Dieser Endpunkt kann verwendet werden, um eine Anmeldung auf einem Gerät zu initiieren und dann abzufragen und zu warten, bis die Anmeldung auf einem anderen Gerät abgeschlossen ist.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

ID
id True string

Der Bezeichner.

Gibt zurück

Erstellen Sie einen Benutzer, und senden Sie dem Benutzer eine Registrierungs-E-Mail oder SMS. Der Benutzer erhält eine E-Mail oder text mit einem Link, um seine Registrierung abzuschließen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

ID
identifier True string

Gültige E-Mail- oder E164-Telefonnummer.

Language
language string

Sprache der zu sendenden E-Mail oder SMS (optional).

Magic Link Path
magic_link_path string

Pfad relativ zum auth_origin der App (optional).

Gibt zurück

OAuth2-Ablauf starten

Startet einen OAuth2-Fluss mit Anforderungsparametern des Verbindungsanbieters, die in https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Umleitungs-URI
redirect_uri True string

Die URL, zu der nach Abschluss des OAuth2-Flusses umgeleitet werden soll.

Staat
state string

Der Zustand, der an den Umleitungs-URI übergeben werden soll.

Codeabfrage
code_challenge True string

Codeabfrage.

Code Challenge-Methode
code_challenge_method True string

Code-Abfragemethode.

Verbindungstyp
connection_type True string

Verbindungsart; google, github, apple oder passage to login with.

OpenID-Konfiguration abrufen

Rufen Sie die OpenID-Konfiguration für eine App ab.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Gibt zurück

Registrieren bei OTP

Erstellen Sie einen Benutzer, und senden Sie dem Benutzer eine Registrierungs-E-Mail oder SMS. Der Benutzer erhält eine E-Mail oder text mit einer Einmalkennung, um die Registrierung abzuschließen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

ID
identifier True string

Gültige E-Mail- oder E164-Telefonnummer.

Language
language string

Sprache der zu sendenden E-Mail (optional).

Gibt zurück

Starten der WebAuthn-Registrierung

Initiieren Sie eine WebAuthn-Registrierung, und erstellen Sie den Benutzer. Dieser Endpunkt erstellt eine WebAuthn-Anmeldeinformationserstellungsabfrage, die zum Durchführen der Registrierungszeremonie aus dem Browser verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

ID
identifier True string

Gültige E-Mail- oder E164-Telefonnummer.

Authenticator-Anlage
authenticator_attachment string

Wählt den Authentifizierungstyp aus, der in dieser WebAuthN-Flussanforderung verwendet wird.

Gibt zurück

Starten des WebAuthn-Add-Geräts

Initiieren Eines WebAuthn-Add-Gerätevorgangs für den aktuellen Benutzer. Dieser Endpunkt erstellt eine WebAuthn-Anmeldeinformationserstellungsabfrage, die zum Durchführen der Registrierungszeremonie aus dem Browser verwendet wird. Der Benutzer muss über ein Bearertoken authentifiziert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Authenticator-Anlage
authenticator_attachment string

Wählt den Authentifizierungstyp aus, der in dieser WebAuthN-Flussanforderung verwendet wird.

Gibt zurück

Telefon ändern

Initiieren sie eine Änderung der Telefonnummer für den authentifizierten Benutzer. Eine Änderung einer Telefonnummer erfordert eine Überprüfung, sodass eine SMS mit einem Link an den Benutzer gesendet wird, den er überprüfen muss, bevor die Änderung der Telefonnummer wirksam wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Language
language string

Sprache der zu sendenden E-Mail (optional).

Magic Link Path
magic_link_path string

Der magische Linkpfad.

Neues Telefon
new_phone string

Die neue Telefonnummer.

Umleitungs-URL
redirect_url string

Die Umleitungs-URL-Adresse.

Gibt zurück

Verknüpfen eines Kontos mit einer Verbindung

Verknüpft ein vorhandenes Konto mit einer OAuth2-Verbindung.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

OAuth2-Code
code True string

Der von der OAuth2-Umleitung angegebene Code.

Überprüfung
verifier True string

Der Prüfer, den der Client ursprünglich an den OAuth2-Anbieter gesendet hat.

WebAuthn-Anmeldung abschließen

Schließt eine WebAuthn-Anmeldung ab und authentifiziert den Benutzer.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

Handshake-ID
handshake_id True string

Der Handshake-Bezeichner.

Authenticator-Anlage
authenticatorAttachment string

Die Authentifikatoranlage.

ID
id string

Der Bezeichner der Anmeldeinformationen. Die Anforderungen für den Bezeichner unterscheiden sich für jeden Anmeldeinformationstyp. Es kann z. B. einen Benutzernamen für Benutzernamen-/Kennwort-Tupel darstellen.

Roh-ID
rawId string

Der unformatierte Bezeichner.

Authentifikatordaten
authenticatorData string

Die Authentifikatordaten.

JSON-Clientdaten
clientDataJSON string

Dieses Attribut enthält eine JSON-Serialisierung der Clientdaten, die vom Client im Aufruf von create() oder get() an den Authentifikator übergeben werden.

Signature
signature string

Die Signatur.

Benutzer
userHandle string

Der Benutzer behandelt.

Typ
type string

Der Wert des [[type]]-Steckplatzes des Objektschnittstellenobjekts, der den durch dieses Objekt dargestellten Anmeldeinformationstyp angibt. Dies sollte "public-key" für Webauthn-Anmeldeinformationen sein.

Benutzer-ID
user_id string

Der Benutzerbezeichner.

Gibt zurück

WebAuthn-Anmeldung starten

Initiieren sie eine WebAuthn-Anmeldung für einen Benutzer. Dieser Endpunkt erstellt eine Anforderung zur Assertion von WebAuthn-Anmeldeinformationen, die zum Ausführen der Anmeldezeremonie aus dem Browser verwendet wird.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
App-ID
app_id True string

App-ID.

ID
identifier string

Gültige E-Mail- oder E164-Telefonnummer.

Gibt zurück

Definitionen

GetAppResponse

Name Pfad Typ Beschreibung
App
app App

LayoutConfig

Name Pfad Typ Beschreibung
H
h integer

Der H-Wert.

ID
id string

Der Bezeichner.

W
w integer

Der W-Wert.

X
x integer

Der X-Wert.

J
y integer

Der Y-Wert.

Layouts

Name Pfad Typ Beschreibung
Profile
profile array of LayoutConfig
Registration
registration array of LayoutConfig

UserMetadataField

Name Pfad Typ Beschreibung
Feldname
field_name string

Der Feldname.

Freundlicher Name
friendly_name string

Der Anzeigename.

ID
id string

Der Bezeichner.

Profile
profile boolean

Gibt an, ob profil.

Registration
registration boolean

Gibt an, ob die Registrierung erfolgt.

Typ
type string

Der Typ.

Anwendung

Name Pfad Typ Beschreibung
Zulässige ID
allowed_identifier string

Der zulässige Bezeichner.

Auth Fallback-Methode
auth_fallback_method string

Veraltete Eigenschaft. Bitte lesen Sie die auth_methods Anzeigeeinstellungen für einzelne Authentifizierungsmethoden.

Auth Fallback-Methode TTL
auth_fallback_method_ttl integer

Veraltete Eigenschaft. Bitte lesen Sie die auth_methods Anzeigeeinstellungen für einzelne Authentifizierungsmethoden.

Auth-Methoden
auth_methods AuthMethods

Gibt an, welche Methoden diese App für die Authentifizierung mit Konfigurationen verwenden darf.

Authentifizierungsursprung
auth_origin string

Der Authentifizierungsursprung.

Standardsprache
default_language string

Die Standardsprache.

element_customization
element_customization ElementCustomization
element_customization_dark
element_customization_dark ElementCustomization
Kurzlebig
ephemeral boolean

Ob kurzlebig.

ID
id string

Der Bezeichner.

Layouts
layouts Layouts
Anmelde-URL
login_url string

Die Anmelde-URL-Adresse.

Name
name string

Der Name.

Passage Branding
passage_branding boolean

Gibt an, ob Passage-Branding verwendet werden soll.

Öffentliche Anmeldung
public_signup boolean

Gibt an, ob die öffentliche Registrierung abgeschlossen ist.

Profilverwaltung
profile_management boolean

Gibt an, ob die Profilverwaltung.

Umleitungs-URL
redirect_url string

Die Umleitungs-URL-Adresse.

E-Mail-Überprüfung
require_email_verification boolean

Gibt an, ob eine E-Mail-Überprüfung erforderlich ist.

ID-Überprüfung
require_identifier_verification boolean

Gibt an, ob eine Überprüfung der ID erforderlich ist.

Erforderliche ID
required_identifier string

Der erforderliche Bezeichner.

RSA Public Key
rsa_public_key string

Der öffentliche RSA-Schlüssel.

Sitzungstimeout
session_timeout_length integer

Die Dauer des Sitzungstimeouts.

social_connections
social_connections SocialConnections
Benutzermetadatenschema
user_metadata_schema array of UserMetadataField

SocialConnections

Name Pfad Typ Beschreibung
googeln
google SocialConnection
GitHub
github SocialConnection

SocialConnection

Name Pfad Typ Beschreibung
Kunden-ID
client_id string

Die Client-ID der sozialen OAuth2-Verbindung.

ElementCustomization

Name Pfad Typ Beschreibung
Hintergrundfarbe für Passagencontainer
passage_container_background_color string

Containerhintergrundfarbe in Hex. Der Standardwert befindet sich #ffffff im hellen Modus und #383838 im dunklen Modus.

Passage Container max. Breite
passage_container_max_width integer

Maximale Breite des Containers (px).

Hintergrundfarbe für Passageneingabefeld
passage_input_box_background_color string

Hintergrundfarbe des Eingabefelds in Hex. Der Standardwert befindet sich #ffffff im hellen Modus und #4b4b4b im dunklen Modus.

Rahmenradius des Passage-Eingabefelds
passage_input_box_border_radius integer

Rahmenradius des Eingabefelds (px).

Schriftart
passage_header_font_family FontFamily

Schriftartenfamilie für Textkörper.

Schriftart
passage_body_font_family FontFamily

Schriftartenfamilie für Textkörper.

Textfarbe der Passagenüberschrift
passage_header_text_color string

Kopfzeilentextfarbe in Hex. Der Standardwert befindet sich #222222 im hellen Modus und #f3f3f3 im dunklen Modus.

Textfarbe des Textkörpers der Passage
passage_body_text_color string

Textkörperfarbe in Hex. Der Standardwert befindet sich #222222 im hellen Modus und #f3f3f3 im dunklen Modus.

Hintergrundfarbe der primären Passage-Schaltfläche
passage_primary_button_background_color string

Hintergrundfarbe der primären Schaltfläche (Hex).

Textfarbe der primären Passage-Schaltfläche
passage_primary_button_text_color string

Schriftfarbe der primären Schaltfläche (Hex).

Passage Primary Button Hover Color
passage_primary_button_hover_color string

Hintergrund der primären Schaltfläche beim Daraufzeigen (Hex).

Rahmenradius der primären Schaltfläche
passage_primary_button_border_radius integer

Rahmenradius der primären Schaltfläche (px).

Rahmenfarbe der primären Passage-Schaltfläche
passage_primary_button_border_color string

Rahmenfarbe der primären Schaltfläche.

Breite des Hauptrahmens der Passage-Schaltfläche
passage_primary_button_border_width integer

Breite des Primären Schaltflächenrahmens (px).

Hintergrundfarbe der sekundären Passage-Schaltfläche
passage_secondary_button_background_color string

Hintergrundfarbe für sekundäre Schaltflächen (Hex).

Sekundäre Textfarbe der Passage sekundärer Buttn
passage_secondary_button_text_color string

Farbe für sekundäre Schaltflächenschriftart (Hex).

Passage Secondary Button Backgroun beim Daraufzeigen
passage_secondary_button_hover_color string

Sekundärer Schaltflächenhintergrund beim Daraufzeigen (Hex).

Randradius der sekundären Passagenschaltfläche
passage_secondary_button_border_radius integer

Randradius der sekundären Schaltfläche (px).

Rahmenfarbe der sekundären Passage-Schaltfläche
passage_secondary_button_border_color string

Sekundäre Rahmenfarbe für Schaltflächen.

Durchgang sekundäre Rahmenbreite
passage_secondary_button_border_width integer

Breite des sekundären Schaltflächenrahmens (px).

FontFamily

Schriftartenfamilie für Textkörper.

Schriftartenfamilie für Textkörper.

Schriftart
string

AuthMethods

Gibt an, welche Methoden diese App für die Authentifizierung mit Konfigurationen verwenden darf.

Name Pfad Typ Beschreibung
Passkeys Auth-Methode
passkeys PasskeysAuthMethod

Das Authentifizierungsobjekt der Passkeys-Methode.

OTP
otp OtpAuthMethod
magic_link
magic_link MagicLinkAuthMethod

PasskeysAuthMethod

Das Authentifizierungsobjekt der Passkeys-Methode.

Name Pfad Typ Beschreibung
Passkeys Auth-Methode
object

Das Authentifizierungsobjekt der Passkeys-Methode.

OtpAuthMethod

Name Pfad Typ Beschreibung
TTL
ttl integer

Maximale Zeit (IN SEKUNDEN), bis die Authentifizierung abläuft.

TTL-Anzeigeeinheit
ttl_display_unit TtlDisplayUnit

Veraltete Eigenschaft. Die bevorzugte Einheit zum Anzeigen der TTL. Dieser Wert ist nur für die Anzeige vorgesehen. * s - Sekunden * - Minuten * mh - Stunden * d - Tage .

MagicLinkAuthMethod

Name Pfad Typ Beschreibung
TTL
ttl integer

Maximale Zeit (IN SEKUNDEN), bis die Authentifizierung abläuft.

TTL-Anzeigeeinheit
ttl_display_unit TtlDisplayUnit

Veraltete Eigenschaft. Die bevorzugte Einheit zum Anzeigen der TTL. Dieser Wert ist nur für die Anzeige vorgesehen. * s - Sekunden * - Minuten * mh - Stunden * d - Tage .

TtlDisplayUnit

Veraltete Eigenschaft. Die bevorzugte Einheit zum Anzeigen der TTL. Dieser Wert ist nur für die Anzeige vorgesehen. * s - Sekunden * - Minuten * mh - Stunden * d - Tage .

Veraltete Eigenschaft. Die bevorzugte Einheit zum Anzeigen der TTL. Dieser Wert ist nur für die Anzeige vorgesehen. * s - Sekunden * - Minuten * mh - Stunden * d - Tage .

TTL-Anzeigeeinheit
string

JWKResponse

Name Pfad Typ Beschreibung
JWK-Antwortschlüssel
keys array of JWKResponse_keys

OpenIdConfiguration

Name Pfad Typ Beschreibung
Autorisierungsendpunkt
authorization_endpoint string

Der Autorisierungsendpunkt.

Emittent
issuer string

Der Aussteller.

JWKs-URI
jwks_uri string

Der JWKs-URI.

CurrentUserResponse

Name Pfad Typ Beschreibung
user
user CurrentUser

Berechtigung

Name Pfad Typ Beschreibung
Erstellt am
created_at string

Das erste Mal, wenn dieses WebAuthn-Gerät verwendet wurde, um den Benutzer zu authentifizieren.

Cred-ID
cred_id string

Die Cred-ID für dieses WebAuthn-Gerät (codiert mit dem, was in psg_cred_obj gespeichert ist).

Freundlicher Name
friendly_name string

Der Anzeigename für das webAuthn-Gerät, das für die Authentifizierung verwendet wird.

ID
id string

Die ID des webAuthn-Geräts, das für die Authentifizierung verwendet wird.

Letzte Anmeldung bei
last_login_at string

Das letzte Mal, wenn dieses WebAuthn-Gerät zum Authentifizieren des Benutzers verwendet wurde.

WebAuthn-Typ
type WebAuthnType

Der Typ dieser Anmeldeinformationen.

Aktualisiert unter
updated_at string

Das letzte Mal, wenn dieses WebAuthn-Gerät aktualisiert wurde.

Nutzungsanzahl
usage_count integer

Wie oft dieses WebAuthn-Gerät verwendet wurde, um den Benutzer zu authentifizieren.

Benutzer-ID
user_id string

Die UserID für dieses WebAuthn-Gerät.

Symbole
icons WebAuthnIcons

Enthält die hellen und dunklen SVG-Symbole, die die Marke dieser Geräte darstellen Werte können null oder base64-codierte SVG sein. Beispiel für SVG-Ausgabe: data:image/svg+xml;base64, PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDE5MiAxOTIiIGhlaWdodD0iMjRweCIgdmlld0JveD0iMCAwIDE5MiAxOTIiIHdpZHRoPSIyNHB4Ij48cmVjdCBmaWxsPSJub25lIiBoZWlnaHQ9IjE5MiIgd2lkdGg9IjE5MiIgeT0iMCIvPjxnPjxwYXRoIGQ9Ik02OS4yOSwxMDZjLTMuNDYsNS45Ny05LjkxLDEwLTE3LjI5LDEwYy0xMS4wMywwLTIwLTguOTctMjAtMjBzOC45Ny0yMCwyMC0yMCBjNy4zOCwwLDEzLjgzLDQuMDMsMTcuMjksMTBoMjUuNTVDOTAuMyw2Ni41NCw3Mi44Miw1Miw1Miw1MkMyNy43NCw1Miw4LDcxLjc0LDgsOTZzMTkuNzQsNDQsNDQsNDRjMjAuODIsMCwzOC4zLTE0LjU0LDQyLjg0LTM0IEg2OS4yOXoiIGZpbGw9IiM0Mjg1RjQiLz48cmVjdCBmaWxsPSIjRkJCQzA0IiBoZWlnaHQ9IjI0IiB3aWR0aD0iNDQiIHg9Ijk0IiB5PSI4NCIvPjxwYXRoIGQ9Ik05NC4zMiw4NEg2OHYwLjA1YzIuNSwzLjM0LDQsNy40Nyw0LDExLjk1cy0xLjUsOC42MS00LDExLjk1VjEwOGgyNi4zMiBjMS4wOC0zLjgyLDEuNjgtNy44NCwxLjY4LTEyUzk1LjQxLDg3LjgyLDk0LjMyLDg0eiIgZmlsbD0iI0VBNDMzNSIvPjxwYXRoIGQ9Ik0xODQsMTA2djI2aC0xNnYtOGMwLTQuNDItMy41OC04LTgtOHMtOCwzLjU4LTgsOHY4aC0xNnYtMjZIMTg0eiIgZmlsbD0iIzM0QTg1MyIvPjxyZWN0IGZpbGw9IiMxODgwMzgiIGhlaWdodD0iMjQiIHdpZHRoPSI0OCIgeD0iMTM2IiB5PSI4NCIvPjwvZz48L3N2Zz4=

Aktueller Benutzer

Name Pfad Typ Beschreibung
Erstellt unter
created_at string

Beim Erstellen dieses Benutzers.

Email
email string

Die E-Mail des Benutzers.

E-Mail bestätigt
email_verified boolean

Gibt an, ob die E-Mail des Benutzers überprüft wurde.

ID
id string

Die Benutzer-ID.

Letzte Anmeldung bei
last_login_at string

Das letzte Mal, wenn sich dieser Benutzer angemeldet hat.

Anmeldeanzahl
login_count integer

Wie oft sich der Benutzer erfolgreich angemeldet hat.

Telefonnummer
phone string

Das Telefon des Benutzers.

Telefon bestätigt
phone_verified boolean

Gibt an, ob das Telefon des Benutzers überprüft wurde.

social_connections
social_connections UserSocialConnections
Benutzerstatus
status UserStatus

Benutzerstatus: aktiv, inaktiv, ausstehend.

Aktualisiert unter
updated_at string

Wann dieser Benutzer zuletzt aktualisiert wurde.

WebAuthn
webauthn boolean

Gibt an, ob sich der Benutzer zuvor über webAuthn authentifiziert hat (wenn len(WebAuthnDevices) > 0).

WebAuthn-Geräte
webauthn_devices array of Credential

Die Liste der Geräte, mit denen sich dieser Benutzer über WebAuthn authentifiziert hat.

WebAuthn-Typen
webauthn_types array of WebAuthnType

Dient zum Abrufen einer Liste von Anmeldeinformationstypen, die der Benutzer erstellt hat.

CurrentUserDevices

Name Pfad Typ Beschreibung
Geräte
devices array of Credential

CurrentUserDevice

Name Pfad Typ Beschreibung
device
device Credential

AddDeviceStartResponse

Name Pfad Typ Beschreibung
Händedruck
handshake CredentialCreationChallenge
user
user User

MagicLinkResponse

Name Pfad Typ Beschreibung
magic_link
magic_link MagicLink
Name Pfad Typ Beschreibung
ID
id string

Der magische Linkbezeichner.

UserMetadataResponse

LoginMagicLinkResponse

Name Pfad Typ Beschreibung
magic_link
magic_link MagicLink

RegisterMagicLinkResponse

Name Pfad Typ Beschreibung
magic_link
magic_link MagicLink

UserResponse

Name Pfad Typ Beschreibung
user
user User

LoginWebAuthnStartResponse

Name Pfad Typ Beschreibung
Händedruck
handshake CredentialAssertionChallenge
user
user User

CredentialAssertionChallenge

Name Pfad Typ Beschreibung
Herausforderung
challenge protocol.CredentialAssertion
ID
id string

Der Bezeichner.

Protokoll. CredentialAssertion

Name Pfad Typ Beschreibung
publicKey
publicKey protocol.CredentialAssertion_publicKey

WebAuthnIcons

Enthält die hellen und dunklen SVG-Symbole, die die Marke dieser Geräte darstellen Werte können null oder base64-codierte SVG sein. Beispiel für SVG-Ausgabe: data:image/svg+xml;base64, PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDE5MiAxOTIiIGhlaWdodD0iMjRweCIgdmlld0JveD0iMCAwIDE5MiAxOTIiIHdpZHRoPSIyNHB4Ij48cmVjdCBmaWxsPSJub25lIiBoZWlnaHQ9IjE5MiIgd2lkdGg9IjE5MiIgeT0iMCIvPjxnPjxwYXRoIGQ9Ik02OS4yOSwxMDZjLTMuNDYsNS45Ny05LjkxLDEwLTE3LjI5LDEwYy0xMS4wMywwLTIwLTguOTctMjAtMjBzOC45Ny0yMCwyMC0yMCBjNy4zOCwwLDEzLjgzLDQuMDMsMTcuMjksMTBoMjUuNTVDOTAuMyw2Ni41NCw3Mi44Miw1Miw1Miw1MkMyNy43NCw1Miw4LDcxLjc0LDgsOTZzMTkuNzQsNDQsNDQsNDRjMjAuODIsMCwzOC4zLTE0LjU0LDQyLjg0LTM0IEg2OS4yOXoiIGZpbGw9IiM0Mjg1RjQiLz48cmVjdCBmaWxsPSIjRkJCQzA0IiBoZWlnaHQ9IjI0IiB3aWR0aD0iNDQiIHg9Ijk0IiB5PSI4NCIvPjxwYXRoIGQ9Ik05NC4zMiw4NEg2OHYwLjA1YzIuNSwzLjM0LDQsNy40Nyw0LDExLjk1cy0xLjUsOC42MS00LDExLjk1VjEwOGgyNi4zMiBjMS4wOC0zLjgyLDEuNjgtNy44NCwxLjY4LTEyUzk1LjQxLDg3LjgyLDk0LjMyLDg0eiIgZmlsbD0iI0VBNDMzNSIvPjxwYXRoIGQ9Ik0xODQsMTA2djI2aC0xNnYtOGMwLTQuNDItMy41OC04LTgtOHMtOCwzLjU4LTgsOHY4aC0xNnYtMjZIMTg0eiIgZmlsbD0iIzM0QTg1MyIvPjxyZWN0IGZpbGw9IiMxODgwMzgiIGhlaWdodD0iMjQiIHdpZHRoPSI0OCIgeD0iMTM2IiB5PSI4NCIvPjwvZz48L3N2Zz4=

Name Pfad Typ Beschreibung
Helles Symbol
light string

Das Helle Symbol.

Dunkles Symbol
dark string

Das dunkle Symbol.

OneTimePasscodeResponse

Name Pfad Typ Beschreibung
OTP-ID
otp_id string

Die ID der einmalkennung. Geben Sie sie beim Aktivieren an.

RegisterWebAuthnStartResponse

Name Pfad Typ Beschreibung
Händedruck
handshake CredentialCreationChallenge
user
user User

SocialConnectionsResponse

Name Pfad Typ Beschreibung
social_connections
social_connections UserSocialConnections

GoogleSocialConnection

Name Pfad Typ Beschreibung
Anbieter-ID
provider_id string

Die externe ID der sozialen Verbindung.

Erstellt unter
created_at date-time

Beim Erstellen bei.

Letzte Anmeldung bei
last_login_at date-time

Die letzte Anmeldung bei.

Anbieter-ID
provider_identifier string

Die E-Mail des verbundenen sozialen Benutzers.

GithubSocialConnection

Name Pfad Typ Beschreibung
Anbieter-ID
provider_id string

Die externe ID der sozialen Verbindung.

Erstellt unter
created_at date-time

Beim Erstellen bei.

Letzte Anmeldung bei
last_login_at date-time

Die letzte Anmeldung bei.

Anbieter-ID
provider_identifier string

Die E-Mail des verbundenen sozialen Benutzers.

UserSocialConnections

Name Pfad Typ Beschreibung
googeln
google GoogleSocialConnection
GitHub
github GithubSocialConnection

UserStatus

Benutzerstatus: aktiv, inaktiv, ausstehend.

Benutzerstatus: aktiv, inaktiv, ausstehend.

Benutzerstatus
string

WebAuthnType

Der Typ dieser Anmeldeinformationen.

Der Typ dieser Anmeldeinformationen.

WebAuthn-Typ
string

CredentialCreation

Name Pfad Typ Beschreibung
publicKey
publicKey CredentialCreation_publicKey

CredentialCreationChallenge

Name Pfad Typ Beschreibung
Herausforderung
challenge CredentialCreation
ID
id string

Der Bezeichner.

Benutzer

Name Pfad Typ Beschreibung
Email
email string

Die E-Mail-Adresse.

E-Mail bestätigt
email_verified boolean

Gibt an, ob die E-Mail des Benutzers überprüft wurde.

ID
id string

Der Bezeichner.

Telefonnummer
phone string

Die Telefonnummer.

Telefon bestätigt
phone_verified boolean

Gibt an, ob das Telefon des Benutzers überprüft wurde.

Benutzerstatus
status UserStatus

Benutzerstatus: aktiv, inaktiv, ausstehend.

WebAuthn Verified
webauthn boolean

Gibt an, ob WebAuthn überprüft wird.

WebAuthn-Typen
webauthn_types array of WebAuthnType

AuthResult

Name Pfad Typ Beschreibung
Authentifizierungstoken
auth_token string

Das Authentifizierungstoken.

Umleitungs-URL
redirect_url string

Die Umleitungs-URL-Adresse.

Aktualisierungstoken
refresh_token string

Das Aktualisierungstoken.

Ablauf des Aktualisierungstokens
refresh_token_expiration integer

Ablauf des Aktualisierungstokens.

AuthResponse

Name Pfad Typ Beschreibung
auth_result
auth_result AuthResult

JWKResponse_keys

Name Pfad Typ Beschreibung
Algorithmus
alg string

Der Algorithmus für den Schlüssel.

Exponent
e string

Der Exponent für den Standardpem.

Schlüssel-ID
kid string

Der eindeutige Bezeichner für den Schlüssel.

Schlüsseltyp
kty string

Der Schlüsseltyp (https://datatracker.ietf.org/doc/html/rfc7518)

Modulus
n string

Das Modul für einen Standardpem.

Verwendung
use string

Verwendung des Schlüssels (d. h. "sig" steht für Signatur)

Protokoll. CredentialAssertion_publicKey

Name Pfad Typ Beschreibung
Herausforderung
challenge string

Die Herausforderung.

RP-ID
rpId string

Der RP-Bezeichner.

Zeitlimit
timeout integer

Die Auszeit.

Benutzerüberprüfung
userVerification string

Dieses Mitglied beschreibt die Anforderungen der vertrauenden Seite hinsichtlich der Benutzerüberprüfung für den Create()-Vorgang. Berechtigte Authentifikatoren werden nur auf diejenigen gefiltert, die diese Anforderung erfüllen können.

CredentialCreation_publicKey_authenticatorSelection

Name Pfad Typ Beschreibung
Authenticator-Anlage
authenticatorAttachment string

Wenn dieses Mitglied vorhanden ist, werden berechtigte Authentifikatoren nur auf Authentifikatoren gefiltert, die mit der angegebenen AuthenticatorAttachment-Enumeration verbunden sind.

Resident Key anfordern
requireResidentKey boolean

Dieses Mitglied beschreibt die Anforderungen der vertrauenden Seite bezüglich der residenten Anmeldeinformationen. Wenn der Parameter auf "true" festgelegt ist, muss der Authentifikator beim Erstellen einer Anmeldeinformationsquelle für öffentliche Schlüssel eine clientseitige Anmeldeinformationsquelle für öffentliche Schlüssel erstellen.

Resident Key
residentKey string

Dieses Mitglied beschreibt die Anforderungen der vertrauenden Seite bezüglich residenter Anmeldeinformationen pro Webauthn-Ebene 2.

Benutzerüberprüfung
userVerification string

Dieses Mitglied beschreibt die Anforderungen der vertrauenden Seite hinsichtlich der Benutzerüberprüfung für den Create()-Vorgang. Berechtigte Authentifikatoren werden nur auf diejenigen gefiltert, die diese Anforderung erfüllen können.

CredentialCreation_publicKey_excludeCredentials

Name Pfad Typ Beschreibung
ID
id string

Die ID einer Anmeldeinformation, die zugelassen/nicht zulässig ist.

Transporte
transports array of string

Der Authentifikator transportiert, der verwendet werden kann.

Typ
type string

Die gültigen Anmeldeinformationstypen.

CredentialCreation_publicKey_pubKeyCredParams

Name Pfad Typ Beschreibung
Algorithmus
alg integer

Der Algorithmus.

Typ
type string

Der Typ.

CredentialCreation_publicKey_rp

Name Pfad Typ Beschreibung
Ikone
icon string

Eine serialisierte URL, die zu einem Bild aufgelöst wird, das der Entität zugeordnet ist. Dies kann z. B. der Avatar eines Benutzers oder das Logo einer vertrauenden Partei sein. Diese URL MUSS eine priori authentifizierte URL sein. Authentifikatoren MÜSSEN eine Mindestlänge von 128 Byte für den Wert eines Symbolelements akzeptieren und speichern. Authentifikatoren KÖNNEN den Wert eines Symbolmembers ignorieren, wenn die Länge größer als 128 Bytes ist. Das Schema der URL kann "Daten" sein, um Abrufe der URL zu vermeiden, um kosten, mehr Speicher zu benötigen. Veraltet: Dies wurde aus den Spezifikationsempfehlungen entfernt.

ID
id string

Ein eindeutiger Bezeichner für die Entität der vertrauenden Seite, die die RP-ID festlegt.

Name
name string

Ein human-palatable-Name für die Entität. Seine Funktion hängt davon ab, was die PublicKeyCredentialEntity darstellt: Wenn sie von PublicKeyCredentialRpEntity geerbt wird, handelt es sich um einen benutzerfreundlichen Bezeichner für die vertrauende Seite, die nur für die Anzeige vorgesehen ist. Beispiel: "ACME Corporation", "Wonderful Widgets, Inc." oder "ОАО Примертех". Wenn sie von PublicKeyCredentialUserEntity geerbt wird, handelt es sich um einen benutzerfreundlichen Bezeichner für ein Benutzerkonto. Es ist nur für die Anzeige vorgesehen, d. h. die Unterstützung des Benutzers bei der Bestimmung des Unterschieds zwischen Benutzerkonten mit ähnlichen displayNames. Beispiel: "alexm", "alex.p.mueller@example.com" oder "+14255551234".

CredentialCreation_publicKey_user

Name Pfad Typ Beschreibung
Anzeigename
displayName string

Ein benutzerfreundlicher Name für das Benutzerkonto, der nur für die Anzeige vorgesehen ist. Die vertrauende Seite SOLLTE es dem Benutzer ermöglichen, dies auszuwählen, und SOLLTE die Auswahl nicht mehr als erforderlich einschränken.

Ikone
icon string

Eine serialisierte URL, die zu einem Bild aufgelöst wird, das der Entität zugeordnet ist. Dies kann z. B. der Avatar eines Benutzers oder das Logo einer vertrauenden Partei sein. Diese URL MUSS eine priori authentifizierte URL sein. Authentifikatoren MÜSSEN eine Mindestlänge von 128 Byte für den Wert eines Symbolelements akzeptieren und speichern. Authentifikatoren KÖNNEN den Wert eines Symbolmembers ignorieren, wenn die Länge größer als 128 Bytes ist. Das Schema der URL kann "Daten" sein, um Abrufe der URL zu vermeiden, um kosten, mehr Speicher zu benötigen. Veraltet: Dies wurde aus den Spezifikationsempfehlungen entfernt.

ID
id object

Der Benutzerhandle der Benutzerkontoentität. Um einen sicheren Betrieb zu gewährleisten, müssen Authentifizierungs- und Autorisierungsentscheidungen auf der Grundlage dieses ID-Mitglieds getroffen werden, nicht auf der Grundlage dieses ID-Mitglieds, nicht des DisplayName- oder Namensmitglieds. Siehe Abschnitt 6.1 von RFC8266.

Name
name string

Ein human-palatable-Name für die Entität. Seine Funktion hängt davon ab, was die PublicKeyCredentialEntity darstellt: Wenn sie von PublicKeyCredentialRpEntity geerbt wird, handelt es sich um einen benutzerfreundlichen Bezeichner für die vertrauende Seite, die nur für die Anzeige vorgesehen ist. Beispiel: "ACME Corporation", "Wonderful Widgets, Inc." oder "ОАО Примертех". Wenn sie von PublicKeyCredentialUserEntity geerbt wird, handelt es sich um einen benutzerfreundlichen Bezeichner für ein Benutzerkonto. Es ist nur für die Anzeige vorgesehen, d. h. die Unterstützung des Benutzers bei der Bestimmung des Unterschieds zwischen Benutzerkonten mit ähnlichen displayNames. Beispiel: "alexm", "alex.p.mueller@example.com" oder "+14255551234".

CredentialCreation_publicKey

Name Pfad Typ Beschreibung
Attestation
attestation string

Der Nachweis.

authenticatorSelection
authenticatorSelection CredentialCreation_publicKey_authenticatorSelection
Herausforderung
challenge string

Die Kreide.

Ausgeschlossene Anmeldeinformationen
excludeCredentials array of CredentialCreation_publicKey_excludeCredentials
Public Key Cred Params
pubKeyCredParams array of CredentialCreation_publicKey_pubKeyCredParams
RP
rp CredentialCreation_publicKey_rp
Zeitlimit
timeout integer

Die Auszeit.

user
user CredentialCreation_publicKey_user