AuthenticationContext Třída

Načte ověřovací tokeny z Azure Active Directory.

Informace o využití najdete ve složce "sample" na adrese: https://github.com/AzureAD/azure-activedirectory-library-for-python

Vytvoří nový objekt AuthenticationContext.

Ve výchozím nastavení se autorita zkontroluje se seznamem známých autorit Azure Active Directory. Pokud autorita není rozpoznána jako jedna z těchto dobře známých autorit, získání tokenu selže. Toto chování je možné vypnout pomocí parametru validate_authority níže.

Dědičnost

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

Vyžadováno

Adresa URL, která identifikuje autoritu tokenu. Měl by mít formát https://login.microsoftonline.com/your_tenant

validate_authority

bool

výchozí hodnota: None

(volitelné) Zapne nebo vypne ověření autority. Výchozí hodnota tohoto parametru je true.

cache

TokenCache

výchozí hodnota: None

(volitelné) Nastaví mezipaměť tokenů používanou touto instancí AuthenticationContext. Pokud tento parametr není nastavený, použije se výchozí hodnota. Instance mezipaměti se používají pouze v této instanci AuthenticationContext a nejsou sdíleny, pokud nebyly ručně předány během vytváření jiných AuthenticationContexts.

api_version

výchozí hodnota: None

(volitelné) Určuje verzi rozhraní API používající na drátě. V minulosti má pevně zakódovanou výchozí hodnotu 1.0. Vývojářům bylo doporučeno, aby ji explicitně nastavili na None, což znamená, že základní verze rozhraní API bude automaticky zvolena. Počínaje ADAL Python 1.0 se tato výchozí hodnota změní na None.

timeout

výchozí hodnota: None

(volitelné) vypršení časového limitu požadavků. Jak dlouho čekat, než server odešle data, než se zřeknou, jako plovoucí nebo (časový limit připojení, časový limit čtení) řazené kolekce členů

enable_pii

výchozí hodnota: False

(volitelné) Pokud není nastavená hodnota True, nebudou v protokolu zapsány žádné identifikovatelné osobní údaje.

verify_ssl

výchozí hodnota: None

(volitelné) ověření požadavků. Buď logická hodnota, v takovém případě určuje, jestli ověřujeme certifikát TLS serveru, nebo řetězec. V takovém případě to musí být cesta ke sadě certifikační autority, která se má použít. Pokud tato hodnota není zadaná a ADAL_PYTHON_SSL_NO_VERIFY je nastavená hodnota env varaible, chování odpovídá verify_ssl=False.

proxies

výchozí hodnota: None

(volitelné) požadavky na proxy servery. Protokol mapování slovníku na adresu URL proxy serveru. Podrobnosti viz http://docs.python-requests.org/en/master/user/advanced/#proxies.

Metody

acquire_token	Získá token pro daný prostředek prostřednictvím tokenů uložených v mezipaměti.
acquire_token_with_authorization_code	Získá token pro daný prostředek prostřednictvím autorizačního kódu pro serverovou aplikaci.
acquire_token_with_client_certificate	Získá token pro daný prostředek prostřednictvím přihlašovacích údajů certifikátu.
acquire_token_with_client_credentials	Získá token pro daný prostředek prostřednictvím přihlašovacích údajů klienta.
acquire_token_with_device_code	Získá nový přístupový token pomocí kódu zařízení.
acquire_token_with_refresh_token	Získá token pro daný prostředek prostřednictvím obnovovacích tokenů.
acquire_token_with_username_password	Získá token pro daný prostředek prostřednictvím přihlašovacích údajů uživatele.
acquire_user_code	Získá informace o kódu uživatele, který obsahuje user_code, device_code pro ověřování uživatele na zařízení.
cancel_request_to_get_token_with_device_code	Zruší požadavek dotazování na získání tokenu s kódem zařízení.

acquire_token

Získá token pro daný prostředek prostřednictvím tokenů uložených v mezipaměti.

acquire_token(resource, user_id, client_id)

Parametry

resource

str

Vyžadováno

Identifikátor URI, který identifikuje prostředek, pro který je token platný.

user_id

str

Vyžadováno

Uživatelské jméno uživatele jménem této aplikace se ověřuje.

client_id

str

Vyžadováno

ID klienta OAuth volající aplikace.

Návraty

dic s několika klíči, včetně "accessToken" a "refreshToken".

acquire_token_with_authorization_code

Získá token pro daný prostředek prostřednictvím autorizačního kódu pro serverovou aplikaci.

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

Parametry

authorization_code

str

Vyžadováno

Autorizační kód vrácený klientem.

redirect_uri

str

Vyžadováno

identifikátor URI přesměrování, který byl použit při autorizované volání.

resource

str

Vyžadováno

Identifikátor URI, který identifikuje prostředek, pro který je token platný.

client_id

str

Vyžadováno

ID klienta OAuth volající aplikace.

client_secret

str

výchozí hodnota: None

(pouze pro důvěrné klienty) Tajný klíč klienta OAuth volající aplikace. Pokud tento parametr není nastavený, má výchozí hodnotu None.

code_verifier

str

výchozí hodnota: None

(volitelné) Ověřovatel kódu, který se použil k získání autorizačního kódu, pokud se v žádosti o udělení autorizačního kódu použila pkce. (obvykle používané veřejnými klienty) Pokud tento parametr není nastavený, má výchozí hodnotu None.

Návraty

dict s několika klíči, včetně "accessToken" a "refreshToken".

acquire_token_with_client_certificate

Získá token pro daný prostředek prostřednictvím přihlašovacích údajů certifikátu.

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

Parametry

resource

str

Vyžadováno

Identifikátor URI, který identifikuje prostředek, pro který je token platný.

client_id

str

Vyžadováno

ID klienta OAuth volající aplikace.

certificate

str

Vyžadováno

Privátní klíč certifikátu s kódováním PEM.

thumbprint

str

Vyžadováno

kryptografický otisk certifikátu zakódovaný šestnáctkovým kódem.

public_certificate

výchozí hodnota: None

Pokud není žádná, odešle se službě pro ověření na základě názvu subjektu a vystavitele, což podporuje automatické vrácení certifikátů. Hodnota musí odpovídat parametru privátního klíče certifikátu.

Návraty

dict s několika klíči, včetně "accessToken".

acquire_token_with_client_credentials

Získá token pro daný prostředek prostřednictvím přihlašovacích údajů klienta.

acquire_token_with_client_credentials(resource, client_id, client_secret)

Parametry

resource

str

Vyžadováno

Identifikátor URI, který identifikuje prostředek, pro který je token platný.

client_id

str

Vyžadováno

ID klienta OAuth volající aplikace.

client_secret

str

Vyžadováno

Tajný klíč klienta OAuth volající aplikace.

Návraty

dict s několika klíči, včetně "accessToken".

acquire_token_with_device_code

Získá nový přístupový token pomocí kódu zařízení.

acquire_token_with_device_code(resource, user_code_info, client_id)

Parametry

resource

str

Vyžadováno

Identifikátor URI, který identifikuje prostředek, pro který je token platný.

user_code_info

dict

Vyžadováno

Informace o kódu z vyvolání "acquire_user_code"

client_id

str

Vyžadováno

ID klienta OAuth volající aplikace.

Návraty

dict s několika klíči, včetně "accessToken" a "refreshToken".

acquire_token_with_refresh_token

Získá token pro daný prostředek prostřednictvím obnovovacích tokenů.

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

Parametry

refresh_token

str

Vyžadováno

Obnovovací token vrácený v odpovědi tokne z předchozího vyvolání acquireToken.

client_id

str

Vyžadováno

ID klienta OAuth volající aplikace.

resource

str

Vyžadováno

Identifikátor URI, který identifikuje prostředek, pro který je token platný.

client_secret

str

výchozí hodnota: None

(volitelné) Tajný klíč klienta OAuth volající aplikace.

Návraty

dict s několika klíči, včetně "accessToken" a "refreshToken".

acquire_token_with_username_password

Získá token pro daný prostředek prostřednictvím přihlašovacích údajů uživatele.

acquire_token_with_username_password(resource, username, password, client_id)

Parametry

resource

str

Vyžadováno

Identifikátor URI, který identifikuje prostředek, pro který je token platný.

username

str

Vyžadováno

Uživatelské jméno uživatele jménem této aplikace se ověřuje.

password

str

Vyžadováno

Heslo uživatele pojmenovaného v parametru username

client_id

str

Vyžadováno

ID klienta OAuth volající aplikace.

Návraty

dict s několika klíči, včetně "accessToken" a "refreshToken".

acquire_user_code

Získá informace o kódu uživatele, který obsahuje user_code, device_code pro ověřování uživatele na zařízení.

acquire_user_code(resource, client_id, language=None)

Parametry

resource

str

Vyžadováno

Identifikátor URI, který identifikuje prostředek, pro který platí device_code a user_code.

client_id

str

Vyžadováno

ID klienta OAuth volající aplikace.

language

str

výchozí hodnota: None

Kód jazyka určující, jak má být zpráva lokalizována.

Návraty

dict obsahuje kód a identifikátor URI, aby se uživatelé mohli přihlásit přes prohlížeč.

cancel_request_to_get_token_with_device_code

Zruší požadavek dotazování na získání tokenu s kódem zařízení.

cancel_request_to_get_token_with_device_code(user_code_info)

Parametry

user_code_info

dict

Vyžadováno

Informace o kódu z vyvolání "acquire_user_code"

Návraty

Žádné

Atributy

options