Udostępnij za pośrednictwem

Dokumentacja interfejsu API po stronie serwera konta Microsoft (MSA)

Konta Microsoft (MSA) to usługa internetowa logowania jednokrotnego, która umożliwia użytkownikom logowanie się do witryn internetowych, aplikacji i usług przy użyciu jednego zestawu poświadczeń. Interfejs API po stronie serwera konta Microsoft (MSA) udostępnia szereg parametrów, które mogą służyć do dostosowywania procesu uwierzytelniania i ulepszania środowiska użytkownika.

Te parametry można używać z biblioteką MSAL na platformie Windows, ułatwiając tworzenie aplikacji systemu Windows, które bezproblemowo integrują się z użytkownikami logujących się za pośrednictwem kont Microsoft.

Interfejs API po stronie serwera MSA

Są one przekazywane do login.microsoftonline.com parametrów adresu URL lub login.live.com w formacie login.microsoftonline.com?parametername=value.

Parametr Wartość Uwagi
ImplicitAssociate 0/1 Jeśli ustawiono wartość 1, konto Microsoft (MSA), którego użytkownik używa do logowania, jest automatycznie połączone z aplikacją w systemie Windows bez konieczności potwierdzenia użytkownika.
Uwaga: nie włącza logowania jednokrotnego dla użytkownika.
LoginHint nazwa użytkownika Wstępnie wypełnia nazwę użytkownika podczas logowania, chyba że została już podana (na przykład za pośrednictwem tokenu odświeżania). Użytkownicy mogą w razie potrzeby modyfikować tę wstępnie wypełniną nazwę użytkownika.
cobrandid identyfikator GUID cobrandingu Ten parametr stosuje cobranding do środowiska użytkownika logowania. Aplikacja Cobranding umożliwia dostosowywanie elementów, takich jak logo aplikacji, obraz tła, tekst podtytułu, tekst opisu i kolory przycisków. Jeśli integrujesz aplikację z logowaniem do konta Microsoft i chcesz dostosować ekran logowania, skontaktuj się z pomocą techniczną firmy Microsoft.
client_flight Sznurek client_flight jest parametrem przekazywania, który jest zwracany do aplikacji po zakończeniu procesu logowania. Wartość tego parametru jest rejestrowana w strumieniu telemetrii i jest używana przez aplikacje do łączenia żądań uwierzytelniania. Może to być korzystne w przypadku korelowania żądań logowania, nawet jeśli nie wszystkie aplikacje mają dostęp do tego strumienia telemetrii. Aplikacje, takie jak Office Union, Teams i inne, są godnymi uwagi użytkownikami tego parametru.
lw 0/1 Uwaga: ta funkcja jest przestarzała. Włącza uproszczone rejestrowanie. Jeśli ta opcja jest włączona, użytkownicy rejestrując się za pośrednictwem przepływu uwierzytelniania nie muszą wprowadzać swojego imienia, nazwiska, kraju/regionu i daty urodzenia, chyba że prawo ma zastosowanie do regionu użytkownika.
fl phone2,
email,
wld,
wld2,
easi,
easi2		 Uwaga: ta funkcja jest przestarzała. Ten parametr steruje opcjami nazwy użytkownika podanymi podczas procesu rejestracji:
phone — ogranicza nazwę użytkownika do numeru telefonu,
phone2 — Domyślnie numer telefonu, ale zezwala na inne opcje,
email — ogranicza nazwę użytkownika do poczty e-mail (Outlook lub EASI),
wld — ogranicza nazwę użytkownika do programu Outlook,
wld2 — Domyślnie program Outlook, ale zezwala na inne opcje, w tym telefon,
easi — ogranicza nazwę użytkownika do interfejsu EASI,
easi2 — Domyślnie jest to EASI, ale zezwala na inne opcje, w tym telefon.
nopa 0/1/2 Uwaga: ta funkcja jest przestarzała. Włącza rejestrację bez hasła. Wartość 1 umożliwia rejestrację bez hasła, ale wymusza tworzenie hasła po upływie 30 dni. Wartość 2 umożliwia rejestrację bez hasła w nieskończoność. Aby użyć wartości 2, aplikacje należy dodać do listy dozwolonych za pomocą procesu ręcznego.
coa 0/1 Uwaga: ta funkcja jest przestarzała. Włącza logowanie bez hasła, wysyłając kod na numer telefonu użytkownika. Aby użyć wartości 1, aplikacje należy dodać do listy dozwolonych za pomocą procesu ręcznego.
signup 0/1 Uruchom przepływ uwierzytelniania na stronie Tworzenie konta , a nie na stronie Logowanie .
fluent 0/1 Uwaga: ta funkcja jest przestarzała. Włącza nowy wygląd i działanie usługi Fluent dla przepływu logowania. Aby użyć wartości 1, aplikacje należy dodać do listy dozwolonych za pomocą procesu ręcznego.
api-version “”/”2.0” W przypadku ustawienia na 2.0wartość parametru ten parametr umożliwia klientowi określenie identyfikatora aplikacji innego niż identyfikator aplikacji wywołującej systemu Windows, biorąc pod uwagę, że określony identyfikator aplikacji jest skonfigurowany tak, aby zezwolił na to.
Clientid/client_id app ID Identyfikator aplikacji wywołujący przepływ uwierzytelniania.
Client_uiflow new_account Umożliwia aplikacjom dodawanie nowego konta bez wywoływania konta AccountsSettingsPane. Wymaga również przekazania typu monitu ForceAuthentication. Wymaga również przekazania typu monitu ForceAuthentication .

Parametry tokenu autoryzacji MSA

Parametr Wartość Uwagi
scope Sznurek Definiuje zakres uprawnień żądanych przez klienta w punktach końcowych autoryzacji i tokenu.
claims Sznurek Określa opcjonalne oświadczenia żądane przez aplikację kliencą.
response_type Sznurek Określa wartość typu odpowiedzi OAuth 2.0, która określa przepływ procesu autoryzacji, w tym parametry zwracane z odpowiednich punktów końcowych.
phone Sznurek Określa rozdzielaną przecinkami listę sformatowanych numerów telefonów połączonych z urządzeniem hosta.
qrcode_uri Sznurek W żądaniach generowania kodu QR w celu przeniesienia uwierzytelnionej sesji ten adres URL jest osadzony w kodzie QR.
Ttv 1 / 2 Do ustalenia
qrcode_state Sznurek W żądaniach tworzenia kodu QR ten parametr stanu jest dołączany do adresu URL wyświetlanego w kodzie QR.
Child_client_id Sznurek Podrzędny identyfikator aplikacji klienckiej w przepływie podwójnego brokera.
child_redirect_uri Sznurek Identyfikator URI przekierowania podrzędnej aplikacji klienckiej używanej w przepływie podwójnego brokera.
safe_rollout Sznurek Parametr służący do określania planu bezpiecznego wdrożenia zastosowanego do żądania. Przydatne, gdy właściciel aplikacji wprowadza zmianę konfiguracji aplikacji i chce, aby zmiany były stosowane stopniowo na potrzeby wdrażania zabezpieczeń.
additional_scope Sznurek Określa dodatkowy zakres, aby usługa uwierzytelniania mogła zebrać dodatkową zgodę w jednym żądaniu. Dzięki temu aplikacja kliencka może uniknąć przerwy w wyrażaniu zgody podczas żądania innego zakresu w przyszłości.
x-client-info 1/0 Token Client_info jest zwracany, gdy wartość to 1.0.
challenge Sznurek Początkowo dostarczana przez aplikację zasobów jest przekazywana przez aplikację kliencka do serwera MSA bez żadnych modyfikacji.
max_age Liczba całkowita Maksymalny wiek uwierzytelniania. Określa dozwolony czas, który upłynął w sekundach od czasu ostatniego uwierzytelnienia użytkownika końcowego przez msa.
mfa_max_age Liczba całkowita Określa dozwolony czas, który upłynął w sekundach od czasu ostatniego przekazania przez użytkownika za pośrednictwem uwierzytelniania wieloskładnikowego w usłudze MSA.
acr_values Sznurek Żądane wartości odwołania do klasy kontekstu uwierzytelniania. Ciąg rozdzielany spacjami, który określa wartości acr, których serwer autoryzacji żąda do użycia do przetwarzania tego żądania uwierzytelniania, z wartościami wyświetlanymi w kolejności preferencji. Klasa kontekstu uwierzytelniania satysfakcjonująca przez wykonane uwierzytelnianie jest zwracana jako wartość oświadczenia acr.
redirect_uri Sznurek Identyfikator URI przekierowania, do którego jest wysyłana odpowiedź. Ten identyfikator URI musi być dokładnie zgodny z jedną z wartości identyfikatorów URI przekierowania dla klienta wstępnie wyrejestrowanego w usłudze MSA.
state Sznurek Nieprzezroczysta wartość używana do zachowania stanu między żądaniem a wywołaniem zwrotnym.
oauth2_response 1 Jeśli jest równa 1, oznacza to, że odpowiedź ws-trust powinna być zgodna z formatem odpowiedzi OAuth.

Zobacz też