AuthenticationContext Klass

Hämtar autentiseringstoken från Azure Active Directory.

För användning kan du kolla in mappen "sample" på: https://github.com/AzureAD/azure-activedirectory-library-for-python

Skapar ett nytt AuthenticationContext-objekt.

Som standard kontrolleras utfärdaren mot en lista över kända Azure Active Directory-myndigheter. Om utfärdaren inte identifieras som en av dessa välkända myndigheter misslyckas tokenförvärvet. Det här beteendet kan inaktiveras via parametern validate_authority nedan.

Arv

builtins.object

AuthenticationContext

Konstruktor

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

Parametrar

authority

str

Obligatorisk

En URL som identifierar en tokenutfärdare. Det bör ha formatet https://login.microsoftonline.com/your_tenant

validate_authority

bool

standardvärde: None

(valfritt) Aktiverar eller inaktiverar verifiering av utfärdare. Den här parametern är som standard true.

cache

TokenCache

standardvärde: None

(valfritt) Anger tokencachen som används av den här AuthenticationContext-instansen. Om den här parametern inte har angetts används en standardinställning. Cacheinstanser används endast av den instansen av AuthenticationContext och delas inte om den inte har skickats manuellt under byggandet av andra AuthenticationContexts.

api_version

standardvärde: None

(valfritt) Anger API-version som använder på tråden. Tidigare har den ett hårdkodat standardvärde som "1.0". Utvecklare har uppmuntrats att uttryckligen ange den som Ingen, vilket innebär att den underliggande API-versionen väljs automatiskt. Från och med ADAL Python 1.0 blir det här standardvärdet Ingen.

timeout

standardvärde: None

Tidsgräns för begäranden (valfritt). Hur lång tid det är att vänta tills servern skickar data innan du ger upp, som en flyttal eller en tuppeln (anslut timeout, lästid).

enable_pii

standardvärde: False

(valfritt) Om detta inte är inställt på Sant skrivs ingen personligt identifierbar information (PII) i loggen.

verify_ssl

standardvärde: None

Verifiera (valfria) begäranden. Antingen ett booleskt värde, i vilket fall det styr om vi verifierar serverns TLS-certifikat eller en sträng, i så fall måste det vara en sökväg till ett CA-paket som ska användas. Om det här värdet inte anges och ADAL_PYTHON_SSL_NO_VERIFY env varaible har angetts motsvarar beteendet verify_ssl=False.

proxies

standardvärde: None

(valfritt) begär proxyservrar. Ordlistemappningsprotokoll till proxyns URL. Mer information finns under http://docs.python-requests.org/en/master/user/advanced/#proxies.

Metoder

acquire_token	Hämtar en token för en viss resurs via cachelagrade token.
acquire_token_with_authorization_code	Hämtar en token för en viss resurs via auktoriseringskod för en serverapp.
acquire_token_with_client_certificate	Hämtar en token för en viss resurs via certifikatautentiseringsuppgifter
acquire_token_with_client_credentials	Hämtar en token för en viss resurs via klientautentiseringsuppgifter.
acquire_token_with_device_code	Hämtar en ny åtkomsttoken med hjälp av en enhetskod.
acquire_token_with_refresh_token	Hämtar en token för en viss resurs via uppdateringstoken
acquire_token_with_username_password	Hämtar en token för en viss resurs via användarens credentails.
acquire_user_code	Hämtar information om användarkod som innehåller user_code device_code för autentisering av användare på enheten.
cancel_request_to_get_token_with_device_code	Avbryter avsökningsbegäran för att hämta token med enhetskod.

acquire_token

Hämtar en token för en viss resurs via cachelagrade token.

acquire_token(resource, user_id, client_id)

Parametrar

resource

str

Obligatorisk

En URI som identifierar den resurs som token är giltig för.

user_id

str

Obligatorisk

Användarens användarnamn för det här programmet autentiseras.

client_id

str

Obligatorisk

OAuth-klient-ID för det anropande programmet.

Returer

dic med flera nycklar, inklusive "accessToken" och "refreshToken".

acquire_token_with_authorization_code

Hämtar en token för en viss resurs via auktoriseringskod för en serverapp.

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

Parametrar

authorization_code

str

Obligatorisk

En auktoriseringskod som returneras från en klient.

redirect_uri

str

Obligatorisk

omdirigerings-URI:n som användes i auktoriseringsanropet.

resource

str

Obligatorisk

En URI som identifierar den resurs som token är giltig för.

client_id

str

Obligatorisk

OAuth-klient-ID för det anropande programmet.

client_secret

str

standardvärde: None

(endast för konfidentiella klienter) OAuth-klienthemligheten för det anropande programmet. Den här parametern om den inte har angetts är standardvärdet Ingen

code_verifier

str

standardvärde: None

(valfritt) Kodverifieraren som användes för att hämta auktoriseringskod om PKCE användes i begäran om beviljande av auktoriseringskod. (används vanligtvis av offentliga klienter) Den här parametern om den inte har angetts är standardvärdet Ingen

Returer

Diktering med flera nycklar, inklusive "accessToken" och "refreshToken".

acquire_token_with_client_certificate

Hämtar en token för en viss resurs via certifikatautentiseringsuppgifter

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

Parametrar

resource

str

Obligatorisk

En URI som identifierar den resurs som token är giltig för.

client_id

str

Obligatorisk

OAuth-klient-ID för det anropande programmet.

certificate

str

Obligatorisk

En PRIVAT PEM-kodad certifikatnyckel.

thumbprint

str

Obligatorisk

hexkodat tumavtryck för certifikatet.

public_certificate

standardvärde: None

om inte Ingen skickas den till tjänsten för ämnesnamn och utfärdarbaserad autentisering, vilket är för att stödja automatiska certifikatvalsar. Värdet måste matcha certifikatets privata nyckelparameter.

Returer

diktering med flera nycklar, inklusive "accessToken".

acquire_token_with_client_credentials

Hämtar en token för en viss resurs via klientautentiseringsuppgifter.

acquire_token_with_client_credentials(resource, client_id, client_secret)

Parametrar

resource

str

Obligatorisk

En URI som identifierar den resurs som token är giltig för.

client_id

str

Obligatorisk

OAuth-klient-ID för det anropande programmet.

client_secret

str

Obligatorisk

OAuth-klienthemligheten för det anropande programmet.

Returer

diktering med flera nycklar, inklusive "accessToken".

acquire_token_with_device_code

Hämtar en ny åtkomsttoken med hjälp av en enhetskod.

acquire_token_with_device_code(resource, user_code_info, client_id)

Parametrar

resource

str

Obligatorisk

En URI som identifierar den resurs som token är giltig för.

user_code_info

dict

Obligatorisk

Kodinformationen från anropet av "acquire_user_code"

client_id

str

Obligatorisk

OAuth-klient-ID för det anropande programmet.

Returer

Diktering med flera nycklar, inklusive "accessToken" och "refreshToken".

acquire_token_with_refresh_token

Hämtar en token för en viss resurs via uppdateringstoken

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

Parametrar

refresh_token

str

Obligatorisk

En uppdateringstoken som returneras i ett tokne-svar från ett tidigare anrop av acquireToken.

client_id

str

Obligatorisk

OAuth-klient-ID för det anropande programmet.

resource

str

Obligatorisk

En URI som identifierar den resurs som token är giltig för.

client_secret

str

standardvärde: None

(valfritt) OAuth-klienthemligheten för det anropande programmet.

Returer

Diktering med flera nycklar, inklusive "accessToken" och "refreshToken".

acquire_token_with_username_password

Hämtar en token för en viss resurs via användarens credentails.

acquire_token_with_username_password(resource, username, password, client_id)

Parametrar

resource

str

Obligatorisk

En URI som identifierar den resurs som token är giltig för.

username

str

Obligatorisk

Användarens användarnamn för det här programmet autentiseras.

password

str

Obligatorisk

Lösenordet för användaren med namnet i användarnamnsparametern.

client_id

str

Obligatorisk

OAuth-klient-ID för det anropande programmet.

Returer

Diktering med flera nycklar, inklusive "accessToken" och "refreshToken".

acquire_user_code

Hämtar information om användarkod som innehåller user_code device_code för autentisering av användare på enheten.

acquire_user_code(resource, client_id, language=None)

Parametrar

resource

str

Obligatorisk

En URI som identifierar den resurs som device_code och user_code är giltig för.

client_id

str

Obligatorisk

OAuth-klient-ID för det anropande programmet.

language

str

standardvärde: None

Språkkoden som anger hur meddelandet ska lokaliseras till.

Returer

dict innehåller kod och uri för användare att logga in via webbläsare.

cancel_request_to_get_token_with_device_code

Avbryter avsökningsbegäran för att hämta token med enhetskod.

cancel_request_to_get_token_with_device_code(user_code_info)

Parametrar

user_code_info

dict

Obligatorisk

Kodinformationen från anropet av "acquire_user_code"

Returer

Ingen

Attribut

options