Fragment: 1Password — Uwierzytelnianie (niezależny wydawca) (wersja zapoznawcza)
Przejście jest wspierane przez 1Password 17+ lat wiodącej w branży wiedzy zabezpieczeń. Całkowicie zastąp istniejący przepływ uwierzytelniania lub utwórz od podstaw niezawodnym rozwiązaniem do uwierzytelniania bez hasła i zarządzania tożsamościami klientów. Zdaj sobie sprawę z pełnych korzyści związanych z zabezpieczeniami, firmami i użytkownikami, eliminując hasła, implementując przepływy logowania obsługiwane za pomocą kluczy dostępu, linków magicznych i kodów logowania.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Troy Taylor |
| adres URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadane łącznika | |
|---|---|
| Publisher | Troy Taylor |
| Witryna internetowa | https://passage.1password.com/ |
| Zasady ochrony prywatności | https://storage.googleapis.com/passage-docs/passage-privacy-policy.pdf |
| Kategorie | Zabezpieczenia |
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz interfejsu API (w postaci "Bearer YOUR_API_KEY") | securestring | Klucz interfejsu API (w postaci "Bearer YOUR_API_KEY" dla tego interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie metadanych użytkownika |
Aktualizuje metadane bieżącego użytkownika. Akceptowane są tylko prawidłowe pola metadanych. Nieprawidłowe pola metadanych, które są obecne, spowodują przerwanie aktualizacji. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego. |
| Aktualizowanie urządzenia |
Aktualizuje urządzenie według identyfikatora bieżącego użytkownika. Obecnie jedynym polem, które można zaktualizować, jest przyjazna nazwa. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego. |
|
Kończenie dodawania urządzenia w usłudze Web |
Wykonuje operację dodawania protokołu WebAuthn dla bieżącego użytkownika. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego. |
|
Kończenie logowania w usłudze Web |
Kończy logowanie w usłudze WebAuthn i uwierzytelnia użytkownika. |
|
Kończenie rejestracji w usłudze Web |
Wykonuje rejestrację protokołu WebAuthn i uwierzytelnia użytkownika. |
| Logowanie przy użyciu protokołu OTP |
Wyślij wiadomość e-mail logowania lub wiadomość SMS do użytkownika. Użytkownik otrzyma wiadomość e-mail lub tekst z jednorazowym kodem dostępu w celu ukończenia logowania. |
| Obsługa wywołania zwrotnego OAuth2 |
Obsługuje wywołanie zwrotne przepływu OAuth2. |
| Odwoływanie tokenu odświeżania |
Odwołuje token odświeżania. |
| Odwoływanie urządzenia |
Odwoływanie urządzenia według identyfikatora bieżącego użytkownika. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego. |
| Pobieranie aplikacji |
Pobieranie informacji o aplikacji. |
| Pobieranie bieżącego użytkownika |
Pobierz informacje o użytkowniku, który jest obecnie uwierzytelniony za pośrednictwem tokenu elementu nośnego. |
| Pobieranie metadanych użytkownika |
Pobierz metadane użytkownika dla bieżącego użytkownika. |
| Pobieranie użytkownika |
Pobierz informacje o użytkowniku, jeśli użytkownik istnieje. Ten punkt końcowy może służyć do określenia, czy użytkownik ma istniejące konto i czy powinien się zalogować, czy zarejestrować. |
| Pobieranie zestawu JWKS |
Pobierz zestaw JWKS dla aplikacji. Zestawy KID w zestawie JWT mogą służyć do dopasowania odpowiedniego zestawu JWK i użyć klucza publicznego zestawu JWK, aby zweryfikować zestaw JWT. |
| Protokół OAuth2 programu Exchange dla tokenu uwierzytelniania |
Wymienia dane połączenia OAuth2 dla tokenu uwierzytelniania. |
| Rejestrowanie przy użyciu protokołu OTP |
Utwórz użytkownika i wyślij do użytkownika wiadomość e-mail z rejestracją lub wiadomość SMS. Użytkownik otrzyma wiadomość e-mail lub tekst z jednorazowym kodem dostępu w celu ukończenia rejestracji. |
| Stan linku magic |
Sprawdź, czy link magiczny został jeszcze aktywowany, czy nie. Po aktywowaniu linku magicznego ten punkt końcowy zwróci token uwierzytelniania dla użytkownika. Ten punkt końcowy może służyć do inicjowania logowania na jednym urządzeniu, a następnie sondowania i oczekiwania na ukończenie logowania na innym urządzeniu. |
| Tworzenie nowego tokenu uwierzytelniania i odświeżania |
Tworzy i zwraca nowy token uwierzytelniania oraz nowy token odświeżania. |
|
Uruchamianie dodawania urządzenia web |
Zainicjuj operację dodawania protokołu WebAuthn dla bieżącego użytkownika. Ten punkt końcowy tworzy wyzwanie tworzenia poświadczeń WebAuthn, które jest używane do przeprowadzania ceremonii rejestracji w przeglądarce. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego. |
| Uruchamianie przepływu OAuth2 |
Rozpoczyna przepływ OAuth2 z parametrami żądania dostawcy połączeń opisanymi w https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest |
|
Uruchom logowanie web |
Zainicjuj logowanie webAuthn dla użytkownika. Ten punkt końcowy tworzy wyzwanie potwierdzenia poświadczeń WebAuthn, które jest używane do przeprowadzania ceremonii logowania z przeglądarki. |
|
Uruchom rejestrację protokołu Web |
Zainicjuj rejestrację protokołu WebAuthn i utwórz użytkownika. Ten punkt końcowy tworzy wyzwanie tworzenia poświadczeń WebAuthn, które jest używane do przeprowadzania ceremonii rejestracji w przeglądarce. |
| Usuwanie połączenia społecznościowego |
Usuwa połączenie społecznościowe dla bieżącego użytkownika. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego. |
| Utwórz użytkownika |
Utwórz użytkownika. |
| Uwierzytelnianie linku magic |
Uwierzytelnia link magiczny dla użytkownika. Ten punkt końcowy sprawdza, czy link magiczny jest prawidłowy, a następnie zwraca token uwierzytelniania dla użytkownika. |
| Uwierzytelnianie OTP |
Uwierzytelnia jednorazowy kod dostępu dla użytkownika. Ten punkt końcowy sprawdza, czy jednorazowy kod dostępu jest prawidłowy, a następnie zwraca token uwierzytelniania dla użytkownika. |
| Uzyskiwanie konfiguracji OpenID |
Pobieranie konfiguracji OpenID dla aplikacji. |
| Uzyskiwanie połączeń społecznościowych |
Pobiera połączenia społecznościowe dla bieżącego użytkownika. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego. |
| Wyświetl listę urządzeń |
Pobierz listę wszystkich urządzeń WebAuthn dla uwierzytelnionego użytkownika. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego. |
| Zaloguj się za pomocą linku magic |
Wyślij wiadomość e-mail logowania lub wiadomość SMS do użytkownika. Użytkownik otrzyma wiadomość e-mail lub tekst z linkiem umożliwiającym ukończenie logowania. |
| Zarejestruj się za pomocą linku magic |
Utwórz użytkownika i wyślij do użytkownika wiadomość e-mail z rejestracją lub wiadomość SMS. Użytkownik otrzyma wiadomość e-mail lub tekst z linkiem umożliwiającym ukończenie rejestracji. |
| Zmienianie telefonu |
Zainicjuj zmianę numeru telefonu dla uwierzytelnionego użytkownika. Zmiana numeru telefonu wymaga weryfikacji, dlatego wiadomość SMS z linkiem zostanie wysłana do użytkownika, który musi zweryfikować, zanim zmiana numeru telefonu zacznie obowiązywać. |
| Zmienianie wiadomości e-mail |
Zainicjuj zmianę wiadomości e-mail dla uwierzytelnionego użytkownika. Zmiana wiadomości e-mail wymaga weryfikacji, więc wiadomość e-mail zostanie wysłana do użytkownika, który musi zweryfikować, zanim zmiana wiadomości e-mail zacznie obowiązywać. |
| Łączenie konta z połączeniem |
Łączy istniejące konto z połączeniem OAuth2. |
Aktualizowanie metadanych użytkownika
Aktualizuje metadane bieżącego użytkownika. Akceptowane są tylko prawidłowe pola metadanych. Nieprawidłowe pola metadanych, które są obecne, spowodują przerwanie aktualizacji. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
Zwraca
- Body
- CurrentUserResponse
Aktualizowanie urządzenia
Aktualizuje urządzenie według identyfikatora bieżącego użytkownika. Obecnie jedynym polem, które można zaktualizować, jest przyjazna nazwa. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Identyfikator urządzenia
|
device_id | True | string |
Identyfikator urządzenia. |
|
Przyjazna nazwa
|
friendly_name | True | string |
Przyjazna nazwa. |
Zwraca
- Body
- CurrentUserDevice
Kończenie dodawania urządzenia w usłudze WebAuthn
Wykonuje operację dodawania protokołu WebAuthn dla bieżącego użytkownika. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Identyfikator uzgadniania
|
handshake_id | True | string |
Identyfikator uzgadniania. |
|
Załącznik wystawcy uwierzytelniającego
|
authenticatorAttachment | string |
Załącznik wystawcy uwierzytelniającego. |
|
|
identyfikator
|
id | string |
Identyfikator poświadczeń. Wymagania dotyczące identyfikatora są odrębne dla każdego typu poświadczeń. Może ona reprezentować nazwę użytkownika dla krotki nazwy użytkownika/hasła, na przykład. |
|
|
Nieprzetworzone identyfikatory
|
rawId | string |
Nieprzetworzonego identyfikatora. |
|
|
Obiekt zaświadczania
|
attestationObject | string |
Obiekt zaświadczania jest wersją fragmentatora bajtów obiektu attestationObject. Ten atrybut zawiera obiekt zaświadczania, który jest nieprzezroczystym obiektem i kryptograficznie chroniony przed manipulowaniem przez klienta. Obiekt zaświadczania zawiera zarówno dane wystawcy uwierzytelniania, jak i instrukcję zaświadczania. Pierwszy zawiera identyfikator AAGUID, unikatowy identyfikator poświadczeń i klucz publiczny poświadczeń. Zawartość instrukcji zaświadczania jest określana przez format instrukcji zaświadczania używany przez wystawcę uwierzytelnienia. Zawiera również wszelkie dodatkowe informacje wymagane przez serwer jednostki uzależnionej do zweryfikowania instrukcji zaświadczania, a także dekodowanie i weryfikowanie danych wystawcy uwierzytelniania wraz z danymi klienta serializowanymi w formacie JSON. |
|
|
Dane klienta JSON
|
clientDataJSON | string |
Ten atrybut zawiera serializacji JSON danych klienta przekazywanych do wystawcy uwierzytelnienia przez klienta w wywołaniu metody create() lub get(). |
|
|
Transport
|
transports | array of string |
Transporty. |
|
|
Transport
|
transports | array of string |
Transporty. |
|
|
Typ
|
type | string |
Wartość gniazda obiektu interfejsu [[type]], który określa typ poświadczeń reprezentowany przez ten obiekt. Powinien to być typ "public-key" dla poświadczeń webauthn. |
|
|
Identyfikator użytkownika
|
user_id | True | string |
Identyfikator użytkownika. |
Zwraca
- Body
- CurrentUserDevice
Kończenie logowania w usłudze WebAuthn
Kończy logowanie w usłudze WebAuthn i uwierzytelnia użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Identyfikator uzgadniania
|
handshake_id | True | string |
Identyfikator uzgadniania. |
|
Załącznik wystawcy uwierzytelniającego
|
authenticatorAttachment | string |
Załącznik wystawcy uwierzytelniającego. |
|
|
identyfikator
|
id | string |
Identyfikator poświadczeń. Wymagania dotyczące identyfikatora są odrębne dla każdego typu poświadczeń. Może ona reprezentować nazwę użytkownika dla krotki nazwy użytkownika/hasła, na przykład. |
|
|
Nieprzetworzone identyfikatory
|
rawId | string |
Nieprzetworzonego identyfikatora. |
|
|
Dane wystawcy uwierzytelniającego
|
authenticatorData | string |
Dane wystawcy uwierzytelniającego. |
|
|
Dane klienta JSON
|
clientDataJSON | string |
Ten atrybut zawiera serializacji JSON danych klienta przekazywanych do wystawcy uwierzytelnienia przez klienta w wywołaniu metody create() lub get(). |
|
|
Signature
|
signature | string |
Podpis. |
|
|
User
|
userHandle | string |
Użytkownik obsługuje. |
|
|
Typ
|
type | string |
Wartość gniazda obiektu interfejsu [[type]], który określa typ poświadczeń reprezentowany przez ten obiekt. Powinien to być typ "public-key" dla poświadczeń webauthn. |
|
|
Identyfikator użytkownika
|
user_id | string |
Identyfikator użytkownika. |
Zwraca
- Body
- AuthResponse
Kończenie rejestracji w usłudze WebAuthn
Wykonuje rejestrację protokołu WebAuthn i uwierzytelnia użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Identyfikator uzgadniania
|
handshake_id | True | string |
Identyfikator uzgadniania. |
|
Załącznik wystawcy uwierzytelniającego
|
authenticatorAttachment | string |
Załącznik wystawcy uwierzytelniającego. |
|
|
identyfikator
|
id | string |
Identyfikator poświadczeń. Wymagania dotyczące identyfikatora są odrębne dla każdego typu poświadczeń. Może ona reprezentować nazwę użytkownika dla krotki nazwy użytkownika/hasła, na przykład. |
|
|
Nieprzetworzone identyfikatory
|
rawId | string |
Nieprzetworzonego identyfikatora. |
|
|
Obiekt zaświadczania
|
attestationObject | string |
Obiekt zaświadczania jest wersją fragmentatora bajtów obiektu attestationObject. Ten atrybut zawiera obiekt zaświadczania, który jest nieprzezroczystym obiektem i kryptograficznie chroniony przed manipulowaniem przez klienta. Obiekt zaświadczania zawiera zarówno dane wystawcy uwierzytelniania, jak i instrukcję zaświadczania. Pierwszy zawiera identyfikator AAGUID, unikatowy identyfikator poświadczeń i klucz publiczny poświadczeń. Zawartość instrukcji zaświadczania jest określana przez format instrukcji zaświadczania używany przez wystawcę uwierzytelnienia. Zawiera również wszelkie dodatkowe informacje wymagane przez serwer jednostki uzależnionej do zweryfikowania instrukcji zaświadczania, a także dekodowanie i weryfikowanie danych wystawcy uwierzytelniania wraz z danymi klienta serializowanymi w formacie JSON. |
|
|
Dane klienta JSON
|
clientDataJSON | string |
Ten atrybut zawiera serializacji JSON danych klienta przekazywanych do wystawcy uwierzytelnienia przez klienta w wywołaniu metody create() lub get(). |
|
|
Transport
|
transports | array of string |
Transporty. |
|
|
Transport
|
transports | array of string |
Transporty. |
|
|
Typ
|
type | string |
Wartość gniazda obiektu interfejsu [[type]], który określa typ poświadczeń reprezentowany przez ten obiekt. Powinien to być typ "public-key" dla poświadczeń webauthn. |
|
|
Identyfikator użytkownika
|
user_id | True | string |
Identyfikator użytkownika. |
Zwraca
- Body
- AuthResponse
Logowanie przy użyciu protokołu OTP
Wyślij wiadomość e-mail logowania lub wiadomość SMS do użytkownika. Użytkownik otrzyma wiadomość e-mail lub tekst z jednorazowym kodem dostępu w celu ukończenia logowania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
identyfikator
|
identifier | True | string |
Prawidłowy adres e-mail lub numer telefonu E164. |
|
Język
|
language | string |
Język wiadomości e-mail do wysłania (opcjonalnie). |
Zwraca
Obsługa wywołania zwrotnego OAuth2
Obsługuje wywołanie zwrotne przepływu OAuth2.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Kod OAuth2
|
code | True | string |
Kod autoryzacji zwrócony przez dostawcę OAuth2. |
|
State
|
state | string |
Stan zwrócony przez dostawcę OAuth2. |
|
|
Error
|
error | string |
Błąd zwrócony przez dostawcę OAuth2. |
|
|
Error
|
error_description | string |
Opis błędu zwrócony przez dostawcę OAuth2. |
Odwoływanie tokenu odświeżania
Odwołuje token odświeżania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Odśwież token
|
refresh_token | True | string |
Odśwież token. |
Odwoływanie urządzenia
Odwoływanie urządzenia według identyfikatora bieżącego użytkownika. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Identyfikator urządzenia
|
device_id | True | string |
Identyfikator urządzenia. |
Pobieranie aplikacji
Pobieranie informacji o aplikacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
Zwraca
- Body
- GetAppResponse
Pobieranie bieżącego użytkownika
Pobierz informacje o użytkowniku, który jest obecnie uwierzytelniony za pośrednictwem tokenu elementu nośnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
Zwraca
- Body
- CurrentUserResponse
Pobieranie metadanych użytkownika
Pobierz metadane użytkownika dla bieżącego użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
Zwraca
- Body
- UserMetadataResponse
Pobieranie użytkownika
Pobierz informacje o użytkowniku, jeśli użytkownik istnieje. Ten punkt końcowy może służyć do określenia, czy użytkownik ma istniejące konto i czy powinien się zalogować, czy zarejestrować.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Adres e-mail lub telefon
|
identifier | True | string |
Adres e-mail lub numer telefonu. |
Zwraca
- Body
- UserResponse
Pobieranie zestawu JWKS
Pobierz zestaw JWKS dla aplikacji. Zestawy KID w zestawie JWT mogą służyć do dopasowania odpowiedniego zestawu JWK i użyć klucza publicznego zestawu JWK, aby zweryfikować zestaw JWT.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
Zwraca
- Body
- JWKResponse
Protokół OAuth2 programu Exchange dla tokenu uwierzytelniania
Wymienia dane połączenia OAuth2 dla tokenu uwierzytelniania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Kod OAuth2
|
code | True | string |
Kod podany z przekierowania OAuth2. |
|
Weryfikator
|
verifier | True | string |
Weryfikator, który klient pierwotnie wysłał do dostawcy OAuth2. |
Zwraca
- Body
- AuthResponse
Rejestrowanie przy użyciu protokołu OTP
Utwórz użytkownika i wyślij do użytkownika wiadomość e-mail z rejestracją lub wiadomość SMS. Użytkownik otrzyma wiadomość e-mail lub tekst z jednorazowym kodem dostępu w celu ukończenia rejestracji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
identyfikator
|
identifier | True | string |
Prawidłowy adres e-mail lub numer telefonu E164. |
|
Język
|
language | string |
Język wiadomości e-mail do wysłania (opcjonalnie). |
Zwraca
Stan linku magic
Sprawdź, czy link magiczny został jeszcze aktywowany, czy nie. Po aktywowaniu linku magicznego ten punkt końcowy zwróci token uwierzytelniania dla użytkownika. Ten punkt końcowy może służyć do inicjowania logowania na jednym urządzeniu, a następnie sondowania i oczekiwania na ukończenie logowania na innym urządzeniu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
identyfikator
|
id | True | string |
Identyfikator. |
Zwraca
- Body
- AuthResponse
Tworzenie nowego tokenu uwierzytelniania i odświeżania
Tworzy i zwraca nowy token uwierzytelniania oraz nowy token odświeżania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Odśwież token
|
refresh_token | True | string |
Token odświeżania. |
Zwraca
- Body
- AuthResponse
Uruchamianie dodawania urządzenia webAuthn
Zainicjuj operację dodawania protokołu WebAuthn dla bieżącego użytkownika. Ten punkt końcowy tworzy wyzwanie tworzenia poświadczeń WebAuthn, które jest używane do przeprowadzania ceremonii rejestracji w przeglądarce. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Załącznik wystawcy uwierzytelniającego
|
authenticator_attachment | string |
Wybiera typ uwierzytelniania, który będzie używany w tym żądaniu przepływu WebAuthN. |
Zwraca
Uruchamianie przepływu OAuth2
Rozpoczyna przepływ OAuth2 z parametrami żądania dostawcy połączeń opisanymi w https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
URI przekierowania
|
redirect_uri | True | string |
Adres URL do przekierowania do adresu po zakończeniu przepływu OAuth2. |
|
State
|
state | string |
Stan przekazywany do identyfikatora URI przekierowania. |
|
|
Wyzwanie kodu
|
code_challenge | True | string |
Wyzwanie kodu. |
|
Code Challenge, metoda
|
code_challenge_method | True | string |
Metoda wyzwania kodu. |
|
Typ połączenia
|
connection_type | True | string |
Typ połączenia; google, github, apple lub przejście do logowania. |
Uruchom logowanie webAuthn
Zainicjuj logowanie webAuthn dla użytkownika. Ten punkt końcowy tworzy wyzwanie potwierdzenia poświadczeń WebAuthn, które jest używane do przeprowadzania ceremonii logowania z przeglądarki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
identyfikator
|
identifier | string |
Prawidłowy adres e-mail lub numer telefonu E164. |
Zwraca
Uruchom rejestrację protokołu WebAuthn
Zainicjuj rejestrację protokołu WebAuthn i utwórz użytkownika. Ten punkt końcowy tworzy wyzwanie tworzenia poświadczeń WebAuthn, które jest używane do przeprowadzania ceremonii rejestracji w przeglądarce.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
identyfikator
|
identifier | True | string |
Prawidłowy adres e-mail lub numer telefonu E164. |
|
Załącznik wystawcy uwierzytelniającego
|
authenticator_attachment | string |
Wybiera typ uwierzytelniania, który będzie używany w tym żądaniu przepływu WebAuthN. |
Zwraca
Usuwanie połączenia społecznościowego
Usuwa połączenie społecznościowe dla bieżącego użytkownika. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Typ połączenia społecznościowego
|
social_connection_type | True | string |
Typ połączenia społecznego. |
Utwórz użytkownika
Utwórz użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
identyfikator
|
identifier | True | string |
Identyfikator. |
Zwraca
- Body
- UserResponse
Uwierzytelnianie linku magic
Uwierzytelnia link magiczny dla użytkownika. Ten punkt końcowy sprawdza, czy link magiczny jest prawidłowy, a następnie zwraca token uwierzytelniania dla użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Link magiczny
|
magic_link | True | string |
Link magiczny. |
Zwraca
- Body
- AuthResponse
Uwierzytelnianie OTP
Uwierzytelnia jednorazowy kod dostępu dla użytkownika. Ten punkt końcowy sprawdza, czy jednorazowy kod dostępu jest prawidłowy, a następnie zwraca token uwierzytelniania dla użytkownika.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
OTP
|
otp | True | string |
Jednorazowy kod dostępu. |
|
Identyfikator OTP
|
otp_id | True | string |
Identyfikator jednorazowego kodu dostępu. |
Zwraca
- Body
- AuthResponse
Uzyskiwanie konfiguracji OpenID
Pobieranie konfiguracji OpenID dla aplikacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
Zwraca
- Body
- OpenIdConfiguration
Uzyskiwanie połączeń społecznościowych
Pobiera połączenia społecznościowe dla bieżącego użytkownika. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
Zwraca
Wyświetl listę urządzeń
Pobierz listę wszystkich urządzeń WebAuthn dla uwierzytelnionego użytkownika. Użytkownik musi być uwierzytelniony za pośrednictwem tokenu elementu nośnego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
Zwraca
- Body
- CurrentUserDevices
Zaloguj się za pomocą linku magic
Wyślij wiadomość e-mail logowania lub wiadomość SMS do użytkownika. Użytkownik otrzyma wiadomość e-mail lub tekst z linkiem umożliwiającym ukończenie logowania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
identyfikator
|
identifier | True | string |
Prawidłowy adres e-mail lub numer telefonu E164. |
|
Język
|
language | string |
Język wiadomości e-mail lub wiadomości SMS do wysłania (opcjonalnie). |
|
|
Ścieżka łącza Magic
|
magic_link_path | string |
Ścieżka względem auth_origin aplikacji (opcjonalnie). |
Zwraca
Zarejestruj się za pomocą linku magic
Utwórz użytkownika i wyślij do użytkownika wiadomość e-mail z rejestracją lub wiadomość SMS. Użytkownik otrzyma wiadomość e-mail lub tekst z linkiem umożliwiającym ukończenie rejestracji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
identyfikator
|
identifier | True | string |
Prawidłowy adres e-mail lub numer telefonu E164. |
|
Język
|
language | string |
Język wiadomości e-mail lub wiadomości SMS do wysłania (opcjonalnie). |
|
|
Ścieżka łącza Magic
|
magic_link_path | string |
Ścieżka względem auth_origin aplikacji (opcjonalnie). |
Zwraca
Zmienianie telefonu
Zainicjuj zmianę numeru telefonu dla uwierzytelnionego użytkownika. Zmiana numeru telefonu wymaga weryfikacji, dlatego wiadomość SMS z linkiem zostanie wysłana do użytkownika, który musi zweryfikować, zanim zmiana numeru telefonu zacznie obowiązywać.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Język
|
language | string |
Język wiadomości e-mail do wysłania (opcjonalnie). |
|
|
Ścieżka łącza Magic
|
magic_link_path | string |
Ścieżka łącza magicznego. |
|
|
Nowy telefon
|
new_phone | string |
Nowy numer telefonu. |
|
|
Adres URL przekierowania
|
redirect_url | string |
Adres URL przekierowania. |
Zwraca
- Body
- MagicLinkResponse
Zmienianie wiadomości e-mail
Zainicjuj zmianę wiadomości e-mail dla uwierzytelnionego użytkownika. Zmiana wiadomości e-mail wymaga weryfikacji, więc wiadomość e-mail zostanie wysłana do użytkownika, który musi zweryfikować, zanim zmiana wiadomości e-mail zacznie obowiązywać.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Język
|
language | string |
Język wiadomości e-mail do wysłania (opcjonalnie). |
|
|
Ścieżka łącza Magic
|
magic_link_path | string |
Ścieżka łącza magicznego. |
|
|
Nowa wiadomość e-mail
|
new_email | True | string |
Nowa wiadomość e-mail. |
|
Adres URL przekierowania
|
redirect_url | string |
Adres URL przekierowania. |
Zwraca
- Body
- MagicLinkResponse
Łączenie konta z połączeniem
Łączy istniejące konto z połączeniem OAuth2.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator aplikacji
|
app_id | True | string |
Identyfikator aplikacji. |
|
Kod OAuth2
|
code | True | string |
Kod podany z przekierowania OAuth2. |
|
Weryfikator
|
verifier | True | string |
Weryfikator, który klient pierwotnie wysłał do dostawcy OAuth2. |
Definicje
GetAppResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
aplikacja
|
app | App |
LayoutConfig
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
H
|
h | integer |
Wartość H. |
|
identyfikator
|
id | string |
Identyfikator. |
|
W
|
w | integer |
Wartość W. |
|
X
|
x | integer |
Wartość X. |
|
Y
|
y | integer |
Wartość Y. |
Layouts
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Profile
|
profile | array of LayoutConfig | |
|
Registration
|
registration | array of LayoutConfig |
Pole UserMetadataField
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa pola
|
field_name | string |
Nazwa pola. |
|
Przyjazna nazwa
|
friendly_name | string |
Przyjazna nazwa. |
|
identyfikator
|
id | string |
Identyfikator. |
|
Profile
|
profile | boolean |
Czy profil. |
|
Registration
|
registration | boolean |
Czy rejestracja. |
|
Typ
|
type | string |
Typ. |
Aplikacja
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dozwolony identyfikator
|
allowed_identifier | string |
Dozwolony identyfikator. |
|
Auth Fallback, metoda
|
auth_fallback_method | string |
Przestarzała właściwość. Aby wyświetlić |
|
Auth Fallback Method TTL
|
auth_fallback_method_ttl | integer |
Przestarzała właściwość. Aby wyświetlić |
|
Metody uwierzytelniania
|
auth_methods | AuthMethods |
Określa metody, których ta aplikacja może używać do uwierzytelniania z konfiguracjami. |
|
Źródło uwierzytelniania
|
auth_origin | string |
Źródło uwierzytelniania. |
|
Język domyślny
|
default_language | string |
Język domyślny. |
|
element_customization
|
element_customization | ElementCustomization | |
|
element_customization_dark
|
element_customization_dark | ElementCustomization | |
|
Efemeryczny
|
ephemeral | boolean |
Czy efemeryczne. |
|
identyfikator
|
id | string |
Identyfikator. |
|
Układów
|
layouts | Layouts | |
|
Adres URL logowania
|
login_url | string |
Adres URL logowania. |
|
Name
|
name | string |
Nazwa. |
|
Znakowanie fragmentów
|
passage_branding | boolean |
Czy używać znakowania Passage. |
|
Rejestracja publiczna
|
public_signup | boolean |
Czy rejestracja publiczna. |
|
Zarządzanie profilami
|
profile_management | boolean |
Czy zarządzanie profilami. |
|
Adres URL przekierowania
|
redirect_url | string |
Adres URL przekierowania. |
|
Weryfikacja poczty e-mail
|
require_email_verification | boolean |
Czy należy wymagać weryfikacji poczty e-mail. |
|
Weryfikacja identyfikatora
|
require_identifier_verification | boolean |
Czy należy wymagać weryfikacji identyfikatora. |
|
Wymagany identyfikator
|
required_identifier | string |
Wymagany identyfikator. |
|
Klucz publiczny RSA
|
rsa_public_key | string |
Klucz publiczny RSA. |
|
Limit czasu sesji
|
session_timeout_length | integer |
Długość limitu czasu sesji. |
|
social_connections
|
social_connections | SocialConnections | |
|
Schemat metadanych użytkownika
|
user_metadata_schema | array of UserMetadataField |
Połączenia społecznościowe
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wyszukiwarka Google
|
SocialConnection | ||
|
GitHub
|
github | SocialConnection |
SocialConnection
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
ID klienta
|
client_id | string |
Identyfikator klienta połączenia społecznościowego OAuth2. |
ElementCustomization
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kolor tła kontenera fragmentu
|
passage_container_background_color | string |
Kolor tła kontenera w szesnastkowym. Wartość domyślna jest |
|
Maksymalna szerokość kontenera fragmentu
|
passage_container_max_width | integer |
Maksymalna szerokość kontenera (px). |
|
Kolor tła pola wejściowego fragmentu
|
passage_input_box_background_color | string |
Kolor tła pola wejściowego w szesnastkowym. Wartość domyślna jest |
|
Promień obramowania pola wejściowego fragmentu
|
passage_input_box_border_radius | integer |
Promień obramowania pola wejściowego (px). |
|
Krój pisma
|
passage_header_font_family | FontFamily |
Rodzina czcionek treści. |
|
Krój pisma
|
passage_body_font_family | FontFamily |
Rodzina czcionek treści. |
|
Kolor tekstu nagłówka fragmentu
|
passage_header_text_color | string |
Kolor tekstu nagłówka w szesnastkowym. Wartość domyślna jest |
|
Kolor tekstu treści fragmentu
|
passage_body_text_color | string |
Kolor tekstu treści w szesnastkowym. Wartość domyślna jest |
|
Kolor tła przycisku podstawowego fragmentu
|
passage_primary_button_background_color | string |
Kolor tła przycisku podstawowego (szesnastkowy). |
|
Kolor tekstu przycisku podstawowego fragmentu
|
passage_primary_button_text_color | string |
Kolor czcionki przycisku podstawowego (szesnastkowy). |
|
Kolor aktywowania przycisku podstawowego fragmentu
|
passage_primary_button_hover_color | string |
Tło przycisku podstawowego po aktywowaniu (szesnastkowym). |
|
Promień obramowania przycisku podstawowego
|
passage_primary_button_border_radius | integer |
Promień obramowania przycisku podstawowego (px). |
|
Kolor obramowania przycisku podstawowego fragmentu
|
passage_primary_button_border_color | string |
Kolor obramowania przycisku podstawowego. |
|
Szerokość obramowania przycisku podstawowego
|
passage_primary_button_border_width | integer |
Szerokość obramowania przycisku podstawowego (px). |
|
Kolor tła przycisku pomocniczego fragmentu
|
passage_secondary_button_background_color | string |
Pomocniczy kolor tła przycisku (szesnastkowy). |
|
Pomocniczy kolor tekstu fragmentu pomocniczego buttn
|
passage_secondary_button_text_color | string |
Pomocniczy kolor czcionki przycisku (szesnastkowy). |
|
Przejście pomocnicze przycisk Backgroun po aktywowaniu
|
passage_secondary_button_hover_color | string |
Tło przycisku pomocniczego po aktywowaniu (szesnastkowym). |
|
Promień obramowania przycisku pomocniczego
|
passage_secondary_button_border_radius | integer |
Promień obramowania przycisku pomocniczego (px). |
|
Kolor obramowania przycisku pomocniczego
|
passage_secondary_button_border_color | string |
Pomocniczy kolor obramowania przycisku. |
|
Szerokość obramowania przycisku pomocniczego
|
passage_secondary_button_border_width | integer |
Szerokość obramowania przycisku pomocniczego (px). |
FontFamily
AuthMethods
Określa metody, których ta aplikacja może używać do uwierzytelniania z konfiguracjami.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Passkeys Auth, metoda
|
passkeys | PasskeysAuthMethod |
Obiekt metody auth passkeys. |
|
OTP (Zabezpieczenie Pozabankowe
|
otp | OtpAuthMethod | |
|
magic_link
|
magic_link | MagicLinkAuthMethod |
PasskeysAuthMethod
Obiekt metody auth passkeys.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Passkeys Auth, metoda
|
object |
Obiekt metody auth passkeys. |
OtpAuthMethod
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Czas wygaśnięcia
|
ttl | integer |
Maksymalny czas (W SEKUNDACH) wygaśnięcia uwierzytelniania. |
|
Jednostka wyświetlania czasu wygaśnięcia
|
ttl_display_unit | TtlDisplayUnit |
Przestarzała właściwość. Preferowana jednostka do wyświetlania czasu wygaśnięcia. Ta wartość jest dostępna tylko dla wyświetlania.
*
|
MagicLinkAuthMethod
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Czas wygaśnięcia
|
ttl | integer |
Maksymalny czas (W SEKUNDACH) wygaśnięcia uwierzytelniania. |
|
Jednostka wyświetlania czasu wygaśnięcia
|
ttl_display_unit | TtlDisplayUnit |
Przestarzała właściwość. Preferowana jednostka do wyświetlania czasu wygaśnięcia. Ta wartość jest dostępna tylko dla wyświetlania.
*
|
TtlDisplayUnit
Przestarzała właściwość. Preferowana jednostka do wyświetlania czasu wygaśnięcia. Ta wartość jest dostępna tylko dla wyświetlania.
*
s - sekundy * - minuty * mh - godziny * d - dni.
Przestarzała właściwość. Preferowana jednostka do wyświetlania czasu wygaśnięcia. Ta wartość jest dostępna tylko dla wyświetlania.
*
s - sekundy * - minuty * mh - godziny * d - dni.
- Jednostka wyświetlania czasu wygaśnięcia
- string
JWKResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Klucze odpowiedzi zestawu JWK
|
keys | array of JWKResponse_keys |
OpenIdConfiguration
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Punkt końcowy autoryzacji
|
authorization_endpoint | string |
Punkt końcowy autoryzacji. |
|
Wystawca
|
issuer | string |
Wystawca. |
|
JWKs URI
|
jwks_uri | string |
Identyfikator URI zestawów JWKs. |
CurrentUserResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
użytkownik
|
user | CurrentUser |
Credential
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Utworzono w
|
created_at | string |
Po raz pierwszy to urządzenie webAuthn zostało użyte do uwierzytelnienia użytkownika. |
|
Identyfikator cred
|
cred_id | string |
Identyfikator Cred dla tego urządzenia webAuthn (zakodowany w celu dopasowania do tego, co jest przechowywane w psg_cred_obj). |
|
Przyjazna nazwa
|
friendly_name | string |
Przyjazna nazwa urządzenia webAuthn używanego do uwierzytelniania. |
|
identyfikator
|
id | string |
Identyfikator urządzenia webAuthn używanego do uwierzytelniania. |
|
Ostatnio zaloguj się pod adresem
|
last_login_at | string |
Ostatni raz to urządzenie webAuthn zostało użyte do uwierzytelnienia użytkownika. |
|
Typ protokołu WebAuthn
|
type | WebAuthnType |
Typ tego poświadczenia. |
|
Zaktualizowano o
|
updated_at | string |
Ostatni raz to urządzenie webAuthn zostało zaktualizowane. |
|
Liczba użycia
|
usage_count | integer |
Ile razy to urządzenie webAuthn zostało użyte do uwierzytelnienia użytkownika. |
|
Identyfikator użytkownika
|
user_id | string |
Identyfikator użytkownika dla tego urządzenia webAuthn. |
|
Ikony
|
icons | WebAuthnIcons |
Zawiera jasne i ciemne ikony SVG reprezentujące markę tych urządzeń Wartości mogą mieć wartość null lub zakodowaną w formacie BASE64 SVG. Przykład danych wyjściowych SVG: data:image/svg+xml;base64, PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDE5MiAxOTIiIGhlaWdodD0iMjRweCIgdmlld0JveD0iMCAwIDE5MiAxOTIiIHdpZHRoPSIyNHB4Ij48cmVjdCBmaWxsPSJub25lIiBoZWlnaHQ9IjE5MiIgd2lkdGg9IjE5MiIgeT0iMCIvPjxnPjxwYXRoIGQ9Ik02OS4yOSwxMDZjLTMuNDYsNS45Ny05LjkxLDEwLTE3LjI5LDEwYy0xMS4wMywwLTIwLTguOTctMjAtMjBzOC45Ny0yMCwyMC0yMCBjNy4zOCwwLDEzLjgzLDQuMDMsMTcuMjksMTBoMjUuNTVDOTAuMyw2Ni41NCw3Mi44Miw1Miw1Miw1MkMyNy43NCw1Miw4LDcxLjc0LDgsOTZzMTkuNzQsNDQsNDQsNDRjMjAuODIsMCwzOC4zLTE0LjU0LDQyLjg0LTM0IEg2OS4yOXoiIGZpbGw9IiM0Mjg1RjQiLz48cmVjdCBmaWxsPSIjRkJCQzA0IiBoZWlnaHQ9IjI0IiB3aWR0aD0iNDQiIHg9Ijk0IiB5PSI4NCIvPjxwYXRoIGQ9Ik05NC4zMiw4NEg2OHYwLjA1YzIuNSwzLjM0LDQsNy40Nyw0LDExLjk1cy0xLjUsOC42MS00LDExLjk1VjEwOGgyNi4zMiBjMS4wOC0zLjgyLDEuNjgtNy44NCwxLjY4LTEyUzk1LjQxLDg3LjgyLDk0LjMyLDg0eiIgZmlsbD0iI0VBNDMzNSIvPjxwYXRoIGQ9Ik0xODQsMTA2djI2aC0xNnYtOGMwLTQuNDItMy41OC04LTgtOHMtOCwzLjU4LTgsOHY4aC0xNnYtMjZIMTg0eiIgZmlsbD0iIzM0QTg1MyIvPjxyZWN0IGZpbGw9IiMxODgwMzgiIGhlaWdodD0iMjQiIHdpZHRoPSI0OCIgeD0iMTM2IIB5PSI4NCIvPjwvZz48L3N2Zz4= |
Bieżący użytkownik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Utworzono pod adresem
|
created_at | string |
Po utworzeniu tego użytkownika. |
|
Email
|
string |
Adres e-mail użytkownika. |
|
|
Zweryfikowana wiadomość e-mail
|
email_verified | boolean |
Niezależnie od tego, czy wiadomość e-mail użytkownika została zweryfikowana. |
|
identyfikator
|
id | string |
Identyfikator użytkownika. |
|
Ostatnio zaloguj się pod adresem
|
last_login_at | string |
Ostatni raz ten użytkownik się zalogował. |
|
Liczba logowań
|
login_count | integer |
Ile razy użytkownik pomyślnie się zalogował. |
|
Telefon
|
phone | string |
Telefon użytkownika. |
|
Zweryfikowany telefon
|
phone_verified | boolean |
Czy telefon użytkownika został zweryfikowany. |
|
social_connections
|
social_connections | UserSocialConnections | |
|
Stan użytkownika
|
status | UserStatus |
Stan użytkownika: aktywny, nieaktywny, oczekujący. |
|
Zaktualizowano o
|
updated_at | string |
Kiedy ten użytkownik został ostatnio zaktualizowany. |
|
WebAuthn
|
webauthn | boolean |
Czy użytkownik uwierzytelnił się za pośrednictwem protokołu webAuthn przed (jeśli len(WebAuthnDevices) > 0). |
|
Urządzenia WebAuthn
|
webauthn_devices | array of Credential |
Lista urządzeń uwierzytelnionych przez tego użytkownika za pośrednictwem protokołu webAuthn. |
|
Typy webauthn
|
webauthn_types | array of WebAuthnType |
Pobierz listę typów poświadczeń utworzonych przez użytkownika. |
CurrentUserDevices
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Urządzenia
|
devices | array of Credential |
CurrentUserDevice
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
urządzenie
|
device | Credential |
AddDeviceStartResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
uzgadnianie
|
handshake | CredentialCreationChallenge | |
|
użytkownik
|
user | User |
MagicLinkResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
magic_link
|
magic_link | MagicLink |
MagicLink
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator linku magicznego. |
UserMetadataResponse
LoginMagicLinkResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
magic_link
|
magic_link | MagicLink |
RegisterMagicLinkResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
magic_link
|
magic_link | MagicLink |
UserResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
użytkownik
|
user | User |
LoginWebAuthnStartResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
uzgadnianie
|
handshake | CredentialAssertionChallenge | |
|
użytkownik
|
user | User |
CredentialAssertionChallenge
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wyzwanie
|
challenge | protocol.CredentialAssertion | |
|
identyfikator
|
id | string |
Identyfikator. |
protokół. CredentialAssertion
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
publicKey
|
publicKey | protocol.CredentialAssertion_publicKey |
WebAuthnIcons
Zawiera jasne i ciemne ikony SVG reprezentujące markę tych urządzeń Wartości mogą mieć wartość null lub zakodowaną w formacie BASE64 SVG. Przykład danych wyjściowych SVG: data:image/svg+xml;base64, PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDE5MiAxOTIiIGhlaWdodD0iMjRweCIgdmlld0JveD0iMCAwIDE5MiAxOTIiIHdpZHRoPSIyNHB4Ij48cmVjdCBmaWxsPSJub25lIiBoZWlnaHQ9IjE5MiIgd2lkdGg9IjE5MiIgeT0iMCIvPjxnPjxwYXRoIGQ9Ik02OS4yOSwxMDZjLTMuNDYsNS45Ny05LjkxLDEwLTE3LjI5LDEwYy0xMS4wMywwLTIwLTguOTctMjAtMjBzOC45Ny0yMCwyMC0yMCBjNy4zOCwwLDEzLjgzLDQuMDMsMTcuMjksMTBoMjUuNTVDOTAuMyw2Ni41NCw3Mi44Miw1Miw1Miw1MkMyNy43NCw1Miw4LDcxLjc0LDgsOTZzMTkuNzQsNDQsNDQsNDRjMjAuODIsMCwzOC4zLTE0LjU0LDQyLjg0LTM0IEg2OS4yOXoiIGZpbGw9IiM0Mjg1RjQiLz48cmVjdCBmaWxsPSIjRkJCQzA0IiBoZWlnaHQ9IjI0IiB3aWR0aD0iNDQiIHg9Ijk0IiB5PSI4NCIvPjxwYXRoIGQ9Ik05NC4zMiw4NEg2OHYwLjA1YzIuNSwzLjM0LDQsNy40Nyw0LDExLjk1cy0xLjUsOC42MS00LDExLjk1VjEwOGgyNi4zMiBjMS4wOC0zLjgyLDEuNjgtNy44NCwxLjY4LTEyUzk1LjQxLDg3LjgyLDk0LjMyLDg0eiIgZmlsbD0iI0VBNDMzNSIvPjxwYXRoIGQ9Ik0xODQsMTA2djI2aC0xNnYtOGMwLTQuNDItMy41OC04LTgtOHMtOCwzLjU4LTgsOHY4aC0xNnYtMjZIMTg0eiIgZmlsbD0iIzM0QTg1MyIvPjxyZWN0IGZpbGw9IiMxODgwMzgiIGhlaWdodD0iMjQiIHdpZHRoPSI0OCIgeD0iMTM2IIB5PSI4NCIvPjwvZz48L3N2Zz4=
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Ikona światła
|
light | string |
Ikona światła. |
|
Ciemna ikona
|
dark | string |
Ciemna ikona. |
OneTimePasscodeResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator OTP
|
otp_id | string |
Identyfikator jednorazowego kodu dostępu. Podaj go podczas aktywowania. |
RegisterWebAuthnStartResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
uzgadnianie
|
handshake | CredentialCreationChallenge | |
|
użytkownik
|
user | User |
SocialConnectionsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
social_connections
|
social_connections | UserSocialConnections |
GoogleSocialConnection
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dostawcy
|
provider_id | string |
Zewnętrzny identyfikator połączenia społecznościowego. |
|
Utworzono pod adresem
|
created_at | date-time |
Po utworzeniu na. |
|
Ostatnio zaloguj się pod adresem
|
last_login_at | date-time |
Ostatnie logowanie. |
|
Identyfikator dostawcy
|
provider_identifier | string |
Wiadomość e-mail połączonego użytkownika społecznościowego. |
GithubSocialConnection
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator dostawcy
|
provider_id | string |
Zewnętrzny identyfikator połączenia społecznościowego. |
|
Utworzono pod adresem
|
created_at | date-time |
Po utworzeniu na. |
|
Ostatnio zaloguj się pod adresem
|
last_login_at | date-time |
Ostatnie logowanie. |
|
Identyfikator dostawcy
|
provider_identifier | string |
Wiadomość e-mail połączonego użytkownika społecznościowego. |
UserSocialConnections
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wyszukiwarka Google
|
GoogleSocialConnection | ||
|
GitHub
|
github | GithubSocialConnection |
UserStatus
Stan użytkownika: aktywny, nieaktywny, oczekujący.
Stan użytkownika: aktywny, nieaktywny, oczekujący.
- Stan użytkownika
- string
WebAuthnType
CredentialCreation (Tworzenie poświadczeń)
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
publicKey
|
publicKey | CredentialCreation_publicKey |
CredentialCreationChallenge
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wyzwanie
|
challenge | CredentialCreation | |
|
identyfikator
|
id | string |
Identyfikator. |
User
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Email
|
string |
Adres e-mail. |
|
|
Zweryfikowana wiadomość e-mail
|
email_verified | boolean |
Niezależnie od tego, czy wiadomość e-mail użytkownika została zweryfikowana. |
|
identyfikator
|
id | string |
Identyfikator. |
|
Telefon
|
phone | string |
Numer telefonu. |
|
Zweryfikowany telefon
|
phone_verified | boolean |
Czy telefon użytkownika został zweryfikowany. |
|
Stan użytkownika
|
status | UserStatus |
Stan użytkownika: aktywny, nieaktywny, oczekujący. |
|
Zweryfikowana usługa WebAuthn
|
webauthn | boolean |
Czy usługa WebAuthn jest weryfikowana. |
|
Typy webauthn
|
webauthn_types | array of WebAuthnType |
AuthResult
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Token uwierzytelniania
|
auth_token | string |
Token uwierzytelniania. |
|
Adres URL przekierowania
|
redirect_url | string |
Adres URL przekierowania. |
|
Odśwież token
|
refresh_token | string |
Token odświeżania. |
|
Wygaśnięcie tokenu odświeżania
|
refresh_token_expiration | integer |
Wygaśnięcie tokenu odświeżania. |
AuthResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
auth_result
|
auth_result | AuthResult |
JWKResponse_keys
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Algorithm
|
alg | string |
Algorytm klucza. |
|
Exponent
|
e | string |
Wykładnik standardowego pem. |
|
Identyfikator klucza
|
kid | string |
Unikatowy identyfikator klucza. |
|
Typ klucza
|
kty | string |
Typ klucza (https://datatracker.ietf.org/doc/html/rfc7518) |
|
Modulus
|
n | string |
Modulo dla standardowego pem. |
|
Użyj
|
use | string |
Sposób użycia klucza (tj. "sig" reprezentuje podpis) |
protokół. CredentialAssertion_publicKey
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wyzwanie
|
challenge | string |
Wyzwanie. |
|
Identyfikator rp
|
rpId | string |
Identyfikator rp. |
|
Przerwa czasowa
|
timeout | integer |
Limit czasu. |
|
Weryfikacja użytkownika
|
userVerification | string |
Ten element członkowski opisuje wymagania jednostki uzależnionej dotyczące weryfikacji użytkownika dla operacji create(). Kwalifikujące się wystawcy uwierzytelnienia są filtrowane tylko do tych, którzy mogą spełnić ten wymóg. |
CredentialCreation_publicKey_authenticatorSelection
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Załącznik wystawcy uwierzytelniającego
|
authenticatorAttachment | string |
Jeśli ten członek jest obecny, kwalifikujące się wystawcy uwierzytelnienia są filtrowane tylko do wystawców uwierzytelnienia dołączonych przy użyciu określonego wyliczenia AuthenticatorAttachment. |
|
Wymagaj klucza rezydenta
|
requireResidentKey | boolean |
Ten element członkowski opisuje wymagania jednostki uzależnionej dotyczące poświadczeń rezydenta. Jeśli parametr ma wartość true, wystawca authenticator MUSI utworzyć źródło poświadczeń klucza publicznego po stronie klienta podczas tworzenia poświadczeń klucza publicznego. |
|
Klucz rezydenta
|
residentKey | string |
Ten element członkowski opisuje wymagania jednostki uzależnionej dotyczące poświadczeń rezydentnych na poziom 2 protokołu Webauthn. |
|
Weryfikacja użytkownika
|
userVerification | string |
Ten element członkowski opisuje wymagania jednostki uzależnionej dotyczące weryfikacji użytkownika dla operacji create(). Kwalifikujące się wystawcy uwierzytelnienia są filtrowane tylko do tych, którzy mogą spełnić ten wymóg. |
CredentialCreation_publicKey_excludeCredentials
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
id | string |
Identyfikator poświadczeń, aby zezwolić na/nie zezwalać. |
|
Transport
|
transports | array of string |
Transporty wystawców uwierzytelnień, które mogą być używane. |
|
Typ
|
type | string |
Prawidłowe typy poświadczeń. |
CredentialCreation_publicKey_pubKeyCredParams
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Algorithm
|
alg | integer |
Algorytm. |
|
Typ
|
type | string |
Typ. |
CredentialCreation_publicKey_rp
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Icon
|
icon | string |
Serializowany adres URL, który jest rozpoznawany jako obraz skojarzony z jednostką. Na przykład może to być awatar użytkownika lub logo jednostki uzależnionej. Ten adres URL MUSI być wcześniej uwierzytelniony adres URL. Wystawcy Authenticators MUSZĄ akceptować i przechowywać minimalną długość 128 bajtów dla wartości elementu członkowskiego ikony. Wystawcy Authenticators MAY ignorują wartość elementu członkowskiego ikony, jeśli jego długość jest większa niż 128 bajtów. Schemat adresu URL MOŻE być "danymi", aby uniknąć pobierania adresu URL, kosztem większej ilości miejsca w magazynie. Przestarzałe: zostało to usunięte z zaleceń dotyczących specyfikacji. |
|
identyfikator
|
id | string |
Unikatowy identyfikator jednostki jednostki uzależnionej, który ustawia identyfikator rp. |
|
Name
|
name | string |
Ludzka nazwa jednostki. Jego funkcja zależy od tego, co reprezentuje PublicKeyCredentialEntity: Po dziedziczeniu przez PublicKeyCredentialRpEntity jest to identyfikator osoby uzależnionej, przeznaczony tylko do wyświetlania. Na przykład "ACME Corporation", "Wonderful Widgets, Inc." lub "ОАО Примертех". Po dziedziczeniu przez element PublicKeyCredentialUserEntity jest to identyfikator czytelny dla użytkownika. Jest przeznaczony tylko do wyświetlania, tj. pomaga użytkownikowi w określaniu różnicy między kontami użytkowników z podobnymi nazwami wyświetlania. Na przykład "alexm", "alex.p.mueller@example.com" lub "+14255551234". |
CredentialCreation_publicKey_user
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Wyświetlana nazwa
|
displayName | string |
Nazwa użytkownika, przeznaczona tylko do wyświetlania. Jednostka uzależniona POWINNA pozwolić użytkownikowi wybrać tę opcję i NIE POWINNO ograniczać wyboru więcej niż jest to konieczne. |
|
Icon
|
icon | string |
Serializowany adres URL, który jest rozpoznawany jako obraz skojarzony z jednostką. Na przykład może to być awatar użytkownika lub logo jednostki uzależnionej. Ten adres URL MUSI być wcześniej uwierzytelniony adres URL. Wystawcy Authenticators MUSZĄ akceptować i przechowywać minimalną długość 128 bajtów dla wartości elementu członkowskiego ikony. Wystawcy Authenticators MAY ignorują wartość elementu członkowskiego ikony, jeśli jego długość jest większa niż 128 bajtów. Schemat adresu URL MOŻE być "danymi", aby uniknąć pobierania adresu URL, kosztem większej ilości miejsca w magazynie. Przestarzałe: zostało to usunięte z zaleceń dotyczących specyfikacji. |
|
identyfikator
|
id | object |
Dojście użytkownika do jednostki konta użytkownika. Aby zapewnić bezpieczną operację, należy podjąć decyzje dotyczące uwierzytelniania i autoryzacji na podstawie tego elementu członkowskiego identyfikatora, a nie nazwy displayName ani elementów członkowskich nazw. Zobacz sekcję 6.1 RFC8266. |
|
Name
|
name | string |
Ludzka nazwa jednostki. Jego funkcja zależy od tego, co reprezentuje PublicKeyCredentialEntity: Po dziedziczeniu przez PublicKeyCredentialRpEntity jest to identyfikator osoby uzależnionej, przeznaczony tylko do wyświetlania. Na przykład "ACME Corporation", "Wonderful Widgets, Inc." lub "ОАО Примертех". Po dziedziczeniu przez element PublicKeyCredentialUserEntity jest to identyfikator czytelny dla użytkownika. Jest przeznaczony tylko do wyświetlania, tj. pomaga użytkownikowi w określaniu różnicy między kontami użytkowników z podobnymi nazwami wyświetlania. Na przykład "alexm", "alex.p.mueller@example.com" lub "+14255551234". |
CredentialCreation_publicKey
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Attestation
|
attestation | string |
Zaświadczenie. |
|
authenticatorSelection
|
authenticatorSelection | CredentialCreation_publicKey_authenticatorSelection | |
|
Wyzwanie
|
challenge | string |
Challege. |
|
Wykluczone poświadczenia
|
excludeCredentials | array of CredentialCreation_publicKey_excludeCredentials | |
|
Params klucza publicznego
|
pubKeyCredParams | array of CredentialCreation_publicKey_pubKeyCredParams | |
|
Rp
|
rp | CredentialCreation_publicKey_rp | |
|
Przerwa czasowa
|
timeout | integer |
Limit czasu. |
|
użytkownik
|
user | CredentialCreation_publicKey_user |