AuthenticationContext Klasa

Pobiera tokeny uwierzytelniania z usługi Azure Active Directory.

W przypadku użycia zapoznaj się z folderem "sample" pod adresem: https://github.com/AzureAD/azure-activedirectory-library-for-python

Tworzy nowy obiekt AuthenticationContext.

Domyślnie urząd będzie sprawdzany względem listy znanych urzędów usługi Azure Active Directory. Jeśli urząd nie zostanie uznany za jeden z tych dobrze znanych władz, pozyskiwanie tokenów zakończy się niepowodzeniem. To zachowanie można wyłączyć za pośrednictwem poniższego parametru validate_authority.

Dziedziczenie

builtins.object

AuthenticationContext

Konstruktor

AuthenticationContext(authority, validate_authority=None, cache=None, api_version=None, timeout=None, enable_pii=False, verify_ssl=None, proxies=None)

Parametry

authority

str

Wymagane

Adres URL identyfikujący urząd tokenu. Powinien być w formacie https://login.microsoftonline.com/your_tenant

validate_authority

bool

wartość domyślna: None

(opcjonalnie) Włącza lub wyłącza walidację urzędu. Ten parametr ma wartość domyślną true.

cache

TokenCache

wartość domyślna: None

(opcjonalnie) Ustawia pamięć podręczną tokenów używaną przez to wystąpienie AuthenticationContext. Jeśli ten parametr nie zostanie ustawiony, zostanie użyta wartość domyślna. Wystąpienia pamięci podręcznej są używane tylko przez to wystąpienie elementu AuthenticationContext i nie są udostępniane, chyba że zostały one ręcznie przekazane podczas budowy innych elementów AuthenticationContext.

api_version

wartość domyślna: None

(opcjonalnie) Określa wersję interfejsu API przy użyciu przewodu. Historycznie ma zakodowaną na stałe wartość domyślną jako "1.0". Deweloperzy zostali zachęcani do ustawienia go jako Brak jawnie, co oznacza, że podstawowa wersja interfejsu API zostanie automatycznie wybrana. Począwszy od biblioteki ADAL Python 1.0, ta wartość domyślna staje się Wartością Brak.

timeout

wartość domyślna: None

(opcjonalnie) limit czasu żądań. Jak długo czekać, aż serwer będzie wysyłał dane przed rezygnacją, jako zmiennoprzecinkowy lub (limit czasu połączenia, limit czasu odczytu) krotki.

enable_pii

wartość domyślna: False

(opcjonalnie) Jeśli nie zostanie ustawiona wartość True, w dzienniku nie będą zapisywane żadne dane osobowe.

verify_ssl

wartość domyślna: None

(opcjonalnie) żądania weryfikacji. Wartość logiczna, w którym przypadku kontroluje, czy weryfikujemy certyfikat TLS serwera, czy ciąg, w którym przypadku musi być ścieżką do pakietu urzędu certyfikacji do użycia. Jeśli ta wartość nie zostanie podana, a ADAL_PYTHON_SSL_NO_VERIFY jest ustawiona wariancja env, zachowanie jest równoważne verify_ssl=False.

proxies

wartość domyślna: None

(opcjonalnie) żąda serwerów proxy. Protokół mapowania słownika na adres URL serwera proxy. Aby uzyskać szczegółowe informacje, zobacz opis funkcji http://docs.python-requests.org/en/master/user/advanced/#proxies.

Metody

acquire_token	Pobiera token dla danego zasobu za pośrednictwem buforowanych tokenów.
acquire_token_with_authorization_code	Pobiera token dla danego zasobu za pośrednictwem kodu autoryzacji dla aplikacji serwera.
acquire_token_with_client_certificate	Pobiera token dla danego zasobu za pomocą poświadczeń certyfikatu
acquire_token_with_client_credentials	Pobiera token dla danego zasobu za pośrednictwem poświadczeń klienta.
acquire_token_with_device_code	Pobiera nowy token dostępu przy użyciu kodu urządzenia.
acquire_token_with_refresh_token	Pobiera token dla danego zasobu za pośrednictwem tokenów odświeżania
acquire_token_with_username_password	Pobiera token dla danego zasobu za pośrednictwem skrdentails użytkownika.
acquire_user_code	Pobiera informacje o kodzie użytkownika zawierające user_code, device_code na potrzeby uwierzytelniania użytkownika na urządzeniu.
cancel_request_to_get_token_with_device_code	Anuluje żądanie sondowania, aby uzyskać token z kodem urządzenia.

acquire_token

Pobiera token dla danego zasobu za pośrednictwem buforowanych tokenów.

acquire_token(resource, user_id, client_id)

Parametry

resource

str

Wymagane

Identyfikator URI identyfikujący zasób, dla którego token jest prawidłowy.

user_id

str

Wymagane

Nazwa użytkownika w imieniu tej aplikacji jest uwierzytelniona.

client_id

str

Wymagane

Identyfikator klienta OAuth aplikacji wywołującej.

Zwraca

dic z kilkoma kluczami, obejmują "accessToken" i "refreshToken".

acquire_token_with_authorization_code

Pobiera token dla danego zasobu za pośrednictwem kodu autoryzacji dla aplikacji serwera.

acquire_token_with_authorization_code(authorization_code, redirect_uri, resource, client_id, client_secret=None, code_verifier=None)

Parametry

authorization_code

str

Wymagane

Kod autoryzacji zwrócony z klienta.

redirect_uri

str

Wymagane

identyfikator URI przekierowania, który został użyty w wywołaniu autoryzacji.

resource

str

Wymagane

Identyfikator URI identyfikujący zasób, dla którego token jest prawidłowy.

client_id

str

Wymagane

Identyfikator klienta OAuth aplikacji wywołującej.

client_secret

str

wartość domyślna: None

(tylko dla klientów poufnych) Klucz tajny klienta OAuth aplikacji wywołującej. Ten parametr, jeśli nie zostanie ustawiony, domyślnie ma wartość Brak

code_verifier

str

wartość domyślna: None

(opcjonalnie) Weryfikator kodu, który został użyty do uzyskania kodu autoryzacji, jeśli PKCE został użyty w żądaniu udzielenia kodu autoryzacji. (zwykle używane przez klientów publicznych) Ten parametr, jeśli nie zostanie ustawiony, domyślnie ma wartość Brak

Zwraca

dict z kilkoma kluczami, obejmują "accessToken" i "refreshToken".

acquire_token_with_client_certificate

Pobiera token dla danego zasobu za pomocą poświadczeń certyfikatu

acquire_token_with_client_certificate(resource, client_id, certificate, thumbprint, public_certificate=None)

Parametry

resource

str

Wymagane

Identyfikator URI identyfikujący zasób, dla którego token jest prawidłowy.

client_id

str

Wymagane

Identyfikator klienta OAuth aplikacji wywołującej.

certificate

str

Wymagane

Klucz prywatny certyfikatu zakodowanego za pomocą protokołu PEM.

thumbprint

str

Wymagane

Odcisk palca zakodowany w szesnastkowym odcisku palca certyfikatu.

public_certificate

wartość domyślna: None

jeśli nie Brak, zostanie ona wysłana do usługi na potrzeby uwierzytelniania opartego na nazwie podmiotu i wystawcy, które ma obsługiwać automatyczne rolls certyfikatu. Wartość musi być zgodna z parametrem klucza prywatnego certyfikatu.

Zwraca

dict z kilkoma kluczami, dołącz "accessToken".

acquire_token_with_client_credentials

Pobiera token dla danego zasobu za pośrednictwem poświadczeń klienta.

acquire_token_with_client_credentials(resource, client_id, client_secret)

Parametry

resource

str

Wymagane

Identyfikator URI identyfikujący zasób, dla którego token jest prawidłowy.

client_id

str

Wymagane

Identyfikator klienta OAuth aplikacji wywołującej.

client_secret

str

Wymagane

Klucz tajny klienta OAuth aplikacji wywołującej.

Zwraca

dict z kilkoma kluczami, dołącz "accessToken".

acquire_token_with_device_code

Pobiera nowy token dostępu przy użyciu kodu urządzenia.

acquire_token_with_device_code(resource, user_code_info, client_id)

Parametry

resource

str

Wymagane

Identyfikator URI identyfikujący zasób, dla którego token jest prawidłowy.

user_code_info

dict

Wymagane

Informacje o kodzie z wywołania "acquire_user_code"

client_id

str

Wymagane

Identyfikator klienta OAuth aplikacji wywołującej.

Zwraca

dict z kilkoma kluczami, obejmują "accessToken" i "refreshToken".

acquire_token_with_refresh_token

Pobiera token dla danego zasobu za pośrednictwem tokenów odświeżania

acquire_token_with_refresh_token(refresh_token, client_id, resource, client_secret=None)

Parametry

refresh_token

str

Wymagane

Token odświeżania zwrócony w odpowiedzi tokne z poprzedniego wywołania metody acquireToken.

client_id

str

Wymagane

Identyfikator klienta OAuth aplikacji wywołującej.

resource

str

Wymagane

Identyfikator URI identyfikujący zasób, dla którego token jest prawidłowy.

client_secret

str

wartość domyślna: None

(opcjonalnie) Klucz tajny klienta OAuth aplikacji wywołującej.

Zwraca

dict z kilkoma kluczami, obejmują "accessToken" i "refreshToken".

acquire_token_with_username_password

Pobiera token dla danego zasobu za pośrednictwem skrdentails użytkownika.

acquire_token_with_username_password(resource, username, password, client_id)

Parametry

resource

str

Wymagane

Identyfikator URI identyfikujący zasób, dla którego token jest prawidłowy.

username

str

Wymagane

Nazwa użytkownika w imieniu tej aplikacji jest uwierzytelniona.

password

str

Wymagane

Hasło użytkownika o nazwie w parametrze nazwy użytkownika.

client_id

str

Wymagane

Identyfikator klienta OAuth aplikacji wywołującej.

Zwraca

dict z kilkoma kluczami, obejmują "accessToken" i "refreshToken".

acquire_user_code

Pobiera informacje o kodzie użytkownika zawierające user_code, device_code na potrzeby uwierzytelniania użytkownika na urządzeniu.

acquire_user_code(resource, client_id, language=None)

Parametry

resource

str

Wymagane

Identyfikator URI identyfikujący zasób, dla którego device_code i user_code jest prawidłowy.

client_id

str

Wymagane

Identyfikator klienta OAuth aplikacji wywołującej.

language

str

wartość domyślna: None

Kod języka określający sposób lokalizowania komunikatu.

Zwraca

dict zawiera kod i identyfikator URI, aby użytkownicy logować się za pośrednictwem przeglądarki.

cancel_request_to_get_token_with_device_code

Anuluje żądanie sondowania, aby uzyskać token z kodem urządzenia.

cancel_request_to_get_token_with_device_code(user_code_info)

Parametry

user_code_info

dict

Wymagane

Informacje o kodzie z wywołania "acquire_user_code"

Zwraca

Brak

Atrybuty

options