AuthenticationContext Klas

Hiermee worden verificatietokens opgehaald uit Azure Active Directory.

Voor gebruiksgegevens bekijkt u de map 'voorbeeld' op: https://github.com/AzureAD/azure-activedirectory-library-for-python

Hiermee maakt u een nieuw AuthenticationContext-object.

De instantie wordt standaard gecontroleerd op basis van een lijst met bekende Azure Active Directory-instanties. Als de instantie niet wordt erkend als een van deze bekende instanties, mislukt het verkrijgen van tokens. Dit gedrag kan worden uitgeschakeld via de onderstaande validate_authority parameter.

Overname
builtins.object
AuthenticationContext

Constructor

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

Parameters

authority
str
Vereist

Een URL die een token-instantie identificeert. Het moet de indeling hebben https://login.microsoftonline.com/your_tenant

validate_authority
bool
standaardwaarde: None

(optioneel) Hiermee schakelt u instantievalidatie in of uit. Deze parameter is standaard ingesteld op true.

cache
TokenCache
standaardwaarde: None

(optioneel) Hiermee stelt u de tokencache in die door dit AuthenticationContext-exemplaar wordt gebruikt. Als deze parameter niet is ingesteld, wordt een standaardwaarde gebruikt. Cache-exemplaren worden alleen gebruikt door dat exemplaar van de AuthenticationContext en worden niet gedeeld, tenzij deze handmatig is doorgegeven tijdens de constructie van andere AuthenticationContexts.

api_version
standaardwaarde: None

(optioneel) Hiermee geeft u de API-versie op die op de draad wordt gebruikt. In het verleden heeft het een vastgelegde standaardwaarde als '1.0'. Ontwikkelaars worden aangemoedigd om deze expliciet in te stellen op Geen, wat betekent dat de onderliggende API-versie automatisch wordt gekozen. Vanaf ADAL Python 1.0 wordt deze standaardwaarde Geen.

timeout
standaardwaarde: None

(optioneel) time-out voor aanvragen. Hoe lang moet worden gewacht totdat de server gegevens verzendt voordat deze wordt opgegeven, als een float-tuple of een tuple (verbindingstime-out, time-out voor lezen).

enable_pii
standaardwaarde: False

(optioneel) Tenzij dit is ingesteld op Waar, wordt er geen persoonlijk identificeerbare informatie (PII) in het logboek geschreven.

verify_ssl
standaardwaarde: None

(optioneel) aanvragen verifiëren. Een booleaanse waarde, in dat geval bepaalt het of we het TLS-certificaat van de server verifiëren, of een tekenreeks. In dat geval moet het een pad zijn naar een CA-bundel die moet worden gebruikt. Als deze waarde niet is opgegeven en ADAL_PYTHON_SSL_NO_VERIFY env varaible is ingesteld, is het gedrag gelijk aan verify_ssl=False.

proxies
standaardwaarde: None

(optioneel) vraagt proxy's aan. Woordenboektoewijzingsprotocol aan de URL van de proxy. Zie http://docs.python-requests.org/en/master/user/advanced/#proxies voor meer informatie.

Methoden

acquire_token

Hiermee haalt u een token op voor een bepaalde resource via tokens in de cache.

acquire_token_with_authorization_code

Hiermee haalt u een token op voor een bepaalde resource via autorisatiecode voor een server-app.

acquire_token_with_client_certificate

Hiermee haalt u een token op voor een bepaalde resource via certificaatreferenties

acquire_token_with_client_credentials

Hiermee haalt u een token op voor een bepaalde resource via clientreferenties.

acquire_token_with_device_code

Hiermee haalt u een nieuw toegangstoken op met behulp van een apparaatcode.

acquire_token_with_refresh_token

Hiermee haalt u een token op voor een bepaalde resource via vernieuwingstokens

acquire_token_with_username_password

Hiermee haalt u een token op voor een bepaalde resource via gebruikers credentails.

acquire_user_code

Hiermee haalt u de gebruikerscodegegevens op die user_code bevatten, device_code voor het verifiëren van de gebruiker op het apparaat.

cancel_request_to_get_token_with_device_code

Hiermee annuleert u de polling-aanvraag om een token met apparaatcode op te halen.

acquire_token

Hiermee haalt u een token op voor een bepaalde resource via tokens in de cache.

acquire_token(resource, user_id, client_id)

Parameters

resource
str
Vereist

Een URI die de resource identificeert waarvoor het token geldig is.

user_id
str
Vereist

De gebruikersnaam van de gebruiker namens deze toepassing wordt geverifieerd.

client_id
str
Vereist

De OAuth-client-id van de aanroepende toepassing.

Retouren

dic met verschillende sleutels, omvatten 'accessToken' en 'refreshToken'.

acquire_token_with_authorization_code

Hiermee haalt u een token op voor een bepaalde resource via autorisatiecode voor een server-app.

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

Parameters

authorization_code
str
Vereist

Een autorisatiecode die wordt geretourneerd door een client.

redirect_uri
str
Vereist

de omleidings-URI die is gebruikt in de autorisatie-aanroep.

resource
str
Vereist

Een URI die de resource identificeert waarvoor het token geldig is.

client_id
str
Vereist

De OAuth-client-id van de aanroepende toepassing.

client_secret
str
standaardwaarde: None

(alleen voor vertrouwelijke clients) Het OAuth-clientgeheim van de aanroepende toepassing. Als deze parameter niet is ingesteld, wordt standaard ingesteld op Geen

code_verifier
str
standaardwaarde: None

(optioneel) De codecontrolefunctie die is gebruikt voor het verkrijgen van autorisatiecode als PKCE is gebruikt in de aanvraag voor het verlenen van de autorisatiecode. (meestal gebruikt door openbare clients) Als deze parameter niet is ingesteld, wordt standaard ingesteld op Geen

Retouren

dict met verschillende sleutels, inclusief 'accessToken' en 'refreshToken'.

acquire_token_with_client_certificate

Hiermee haalt u een token op voor een bepaalde resource via certificaatreferenties

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

Parameters

resource
str
Vereist

Een URI die de resource identificeert waarvoor het token geldig is.

client_id
str
Vereist

De OAuth-client-id van de aanroepende toepassing.

certificate
str
Vereist

Een persoonlijke sleutel met PEM-gecodeerd certificaat.

thumbprint
str
Vereist

hex gecodeerde vingerafdruk van het certificaat.

public_certificate
standaardwaarde: None

Als dit geen is, wordt deze naar de service verzonden voor verificatie op basis van onderwerpnaam en verlener, die automatische rollers van certificaten ondersteunt. De waarde moet overeenkomen met de persoonlijke sleutelparameter van het certificaat.

Retouren

dict met verschillende sleutels, inclusief 'accessToken'.

acquire_token_with_client_credentials

Hiermee haalt u een token op voor een bepaalde resource via clientreferenties.

acquire_token_with_client_credentials(resource, client_id, client_secret)

Parameters

resource
str
Vereist

Een URI die de resource identificeert waarvoor het token geldig is.

client_id
str
Vereist

De OAuth-client-id van de aanroepende toepassing.

client_secret
str
Vereist

Het OAuth-clientgeheim van de aanroepende toepassing.

Retouren

dict met verschillende sleutels, inclusief 'accessToken'.

acquire_token_with_device_code

Hiermee haalt u een nieuw toegangstoken op met behulp van een apparaatcode.

acquire_token_with_device_code(resource, user_code_info, client_id)

Parameters

resource
str
Vereist

Een URI die de resource identificeert waarvoor het token geldig is.

user_code_info
dict
Vereist

De codegegevens van de aanroep van 'acquire_user_code'

client_id
str
Vereist

De OAuth-client-id van de aanroepende toepassing.

Retouren

dict met verschillende sleutels, inclusief 'accessToken' en 'refreshToken'.

acquire_token_with_refresh_token

Hiermee haalt u een token op voor een bepaalde resource via vernieuwingstokens

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

Parameters

refresh_token
str
Vereist

Een vernieuwingstoken dat is geretourneerd in een tokne-antwoord van een eerdere aanroep van acquireToken.

client_id
str
Vereist

De OAuth-client-id van de aanroepende toepassing.

resource
str
Vereist

Een URI die de resource identificeert waarvoor het token geldig is.

client_secret
str
standaardwaarde: None

(optioneel) Het OAuth-clientgeheim van de aanroepende toepassing.

Retouren

dict met verschillende sleutels, inclusief 'accessToken' en 'refreshToken'.

acquire_token_with_username_password

Hiermee haalt u een token op voor een bepaalde resource via gebruikers credentails.

acquire_token_with_username_password(resource, username, password, client_id)

Parameters

resource
str
Vereist

Een URI die de resource identificeert waarvoor het token geldig is.

username
str
Vereist

De gebruikersnaam van de gebruiker namens deze toepassing wordt geverifieerd.

password
str
Vereist

Het wachtwoord van de gebruiker met de naam in de gebruikersnaamparameter.

client_id
str
Vereist

De OAuth-client-id van de aanroepende toepassing.

Retouren

dict met verschillende sleutels, inclusief 'accessToken' en 'refreshToken'.

acquire_user_code

Hiermee haalt u de gebruikerscodegegevens op die user_code bevatten, device_code voor het verifiëren van de gebruiker op het apparaat.

acquire_user_code(resource, client_id, language=None)

Parameters

resource
str
Vereist

Een URI die de resource identificeert waarvoor de device_code en user_code geldig zijn.

client_id
str
Vereist

De OAuth-client-id van de aanroepende toepassing.

language
str
standaardwaarde: None

De taalcode die aangeeft hoe het bericht moet worden gelokaliseerd.

Retouren

dict bevat code en URI voor gebruikers om zich aan te melden via de browser.

cancel_request_to_get_token_with_device_code

Hiermee annuleert u de polling-aanvraag om een token met apparaatcode op te halen.

cancel_request_to_get_token_with_device_code(user_code_info)

Parameters

user_code_info
dict
Vereist

De codegegevens van de aanroep van 'acquire_user_code'

Retouren

Geen

Kenmerken

options