AuthenticationContext Klasse

Ruft Authentifizierungstoken aus Azure Active Directory ab.

Informationen zu Verwendungen finden Sie im Ordner "sample" unter: https://github.com/AzureAD/azure-activedirectory-library-for-python

Erstellt ein neues AuthenticationContext-Objekt.

Standardmäßig wird die Autorität anhand einer Liste bekannter Azure Active Directory-Autoritäten überprüft. Wenn die Autorität nicht als eine dieser bekannten Autoritäten erkannt wird, schlägt der Tokenerwerb fehl. Dieses Verhalten kann über den parameter validate_authority unten deaktiviert werden.

Vererbung

builtins.object

AuthenticationContext

Konstruktor

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

Parameter

authority

str

Erforderlich

Eine URL, die eine Tokenautorität identifiziert. Es sollte das Format haben. https://login.microsoftonline.com/your_tenant

validate_authority

bool

Standardwert: None

(optional) Aktiviert oder deaktiviert die Überprüfung der Autorität. Dieser Parameter ist standardmäßig auf true festgelegt.

cache

TokenCache

Standardwert: None

(optional) Legt den Tokencache fest, der von diesem AuthenticationContext-instance verwendet wird. Wenn dieser Parameter nicht festgelegt ist, wird ein Standardwert verwendet. Cacheinstanzen werden nur von diesem instance von AuthenticationContext verwendet und nicht freigegeben, es sei denn, sie wurden während der Erstellung anderer AuthenticationContexts manuell übergeben.

api_version

Standardwert: None

(optional) Gibt die API-Version mit on the wire an. In der Vergangenheit hat es einen hartcodierten Standardwert als "1,0". Entwickler wurden empfohlen, sie explizit auf None festzulegen, was bedeutet, dass die zugrunde liegende API-Version automatisch ausgewählt wird. Ab ADAL Python 1.0 wird dieser Standardwert zu None.

timeout

Standardwert: None

(optional) fordert Timeout an. Gibt an, wie lange gewartet werden soll, bis der Server Daten sendet, bevor er aufgibt, als Float oder als Tupel (Verbindungstimeout, Timeout lesen).

enable_pii

Standardwert: False

(optional) Sofern dies nicht auf True festgelegt ist, werden keine personenbezogenen Informationen (PiI) im Protokoll geschrieben.

verify_ssl

Standardwert: None

(optional) anforderungen überprüfen. Entweder ein boolescher Wert, in diesem Fall wird gesteuert, ob das TLS-Zertifikat des Servers überprüft wird, oder eine Zeichenfolge. In diesem Fall muss es sich um einen Pfad zu einem zu verwendenden Zertifizierungsstellenpaket handeln. Wenn dieser Wert nicht angegeben wird und ADAL_PYTHON_SSL_NO_VERIFY env varaible festgelegt ist, entspricht das Verhalten verify_ssl=False.

proxies

Standardwert: None

(optional) fordert Proxys an. Wörterbuchzuordnungsprotokoll zur URL des Proxys. Einzelheiten dazu finden Sie unter http://docs.python-requests.org/en/master/user/advanced/#proxies.

Methoden

acquire_token	Ruft ein Token für eine bestimmte Ressource über zwischengespeicherte Token ab.
acquire_token_with_authorization_code	Ruft ein Token für eine bestimmte Ressource über den Autorisierungscode für eine Server-App ab.
acquire_token_with_client_certificate	Ruft ein Token für eine bestimmte Ressource über Zertifikatanmeldeinformationen ab.
acquire_token_with_client_credentials	Ruft ein Token für eine bestimmte Ressource über Clientanmeldeinformationen ab.
acquire_token_with_device_code	Ruft mithilfe eines Gerätecodes ein neues Zugriffstoken ab.
acquire_token_with_refresh_token	Ruft ein Token für eine bestimmte Ressource über Aktualisierungstoken ab.
acquire_token_with_username_password	Ruft ein Token für eine bestimmte Ressource über Benutzerspalten ab.
acquire_user_code	Ruft die Benutzercodeinformationen ab, die user_code enthalten, device_code für die Authentifizierung des Benutzers auf dem Gerät.
cancel_request_to_get_token_with_device_code	Bricht die Abrufanforderung ab, um das Token mit Gerätecode abzurufen.

acquire_token

Ruft ein Token für eine bestimmte Ressource über zwischengespeicherte Token ab.

acquire_token(resource, user_id, client_id)

Parameter

resource

str

Erforderlich

Ein URI, der die Ressource identifiziert, für die das Token gültig ist.

user_id

str

Erforderlich

Der Benutzername des Benutzers im Namen dieser Anwendung authentifiziert sich.

client_id

str

Erforderlich

Die OAuth-Client-ID der aufrufenden Anwendung.

Gibt zurück

dic mit mehreren Schlüsseln, enthalten "accessToken" und "refreshToken".

acquire_token_with_authorization_code

Ruft ein Token für eine bestimmte Ressource über den Autorisierungscode für eine Server-App ab.

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

Parameter

authorization_code

str

Erforderlich

Ein von einem Client zurückgegebener Autorisierungscode.

redirect_uri

str

Erforderlich

Der Umleitungs-URI, der im Autorisierungsaufruf verwendet wurde.

resource

str

Erforderlich

Ein URI, der die Ressource identifiziert, für die das Token gültig ist.

client_id

str

Erforderlich

Die OAuth-Client-ID der aufrufenden Anwendung.

client_secret

str

Standardwert: None

(nur für vertrauliche Clients) Der geheime OAuth-Clientschlüssel der aufrufenden Anwendung. Wenn dieser Parameter nicht festgelegt ist, wird standardmäßig None verwendet.

code_verifier

str

Standardwert: None

(optional) Die Codeüberprüfung, die zum Abrufen des Autorisierungscodes verwendet wurde, wenn PKCE in der Autorisierungscodegenehmigungsanforderung verwendet wurde. (in der Regel von öffentlichen Clients verwendet) Wenn dieser Parameter nicht festgelegt ist, wird standardmäßig None verwendet.

Gibt zurück

dict mit mehreren Schlüsseln, enthalten "accessToken" und "refreshToken".

acquire_token_with_client_certificate

Ruft ein Token für eine bestimmte Ressource über Zertifikatanmeldeinformationen ab.

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

Parameter

resource

str

Erforderlich

Ein URI, der die Ressource identifiziert, für die das Token gültig ist.

client_id

str

Erforderlich

Die OAuth-Client-ID der aufrufenden Anwendung.

certificate

str

Erforderlich

Ein privater Schlüssel mit PEM-codiertem Zertifikat.

thumbprint

str

Erforderlich

hexcodierter Fingerabdruck des Zertifikats.

public_certificate

Standardwert: None

Wenn nicht Keine, wird er an den Dienst gesendet, um den Antragstellernamen und die ausstellerbasierte Authentifizierung zu erhalten, die automatische Zertifikatrollen unterstützen soll. Der Wert muss mit dem Parameter für den privaten Schlüssel des Zertifikats übereinstimmen.

Gibt zurück

dict mit mehreren Schlüsseln, schließen Sie "accessToken" ein.

acquire_token_with_client_credentials

Ruft ein Token für eine bestimmte Ressource über Clientanmeldeinformationen ab.

acquire_token_with_client_credentials(resource, client_id, client_secret)

Parameter

resource

str

Erforderlich

Ein URI, der die Ressource identifiziert, für die das Token gültig ist.

client_id

str

Erforderlich

Die OAuth-Client-ID der aufrufenden Anwendung.

client_secret

str

Erforderlich

Der geheime OAuth-Clientschlüssel der aufrufenden Anwendung.

Gibt zurück

dict mit mehreren Schlüsseln, schließen Sie "accessToken" ein.

acquire_token_with_device_code

Ruft mithilfe eines Gerätecodes ein neues Zugriffstoken ab.

acquire_token_with_device_code(resource, user_code_info, client_id)

Parameter

resource

str

Erforderlich

Ein URI, der die Ressource identifiziert, für die das Token gültig ist.

user_code_info

dict

Erforderlich

Die Codeinformationen aus dem Aufruf von "acquire_user_code"

client_id

str

Erforderlich

Die OAuth-Client-ID der aufrufenden Anwendung.

Gibt zurück

dict mit mehreren Schlüsseln, enthalten "accessToken" und "refreshToken".

acquire_token_with_refresh_token

Ruft ein Token für eine bestimmte Ressource über Aktualisierungstoken ab.

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

Parameter

refresh_token

str

Erforderlich

Ein Aktualisierungstoken, das in einer tokne-Antwort von einem vorherigen Aufruf von acquireToken zurückgegeben wurde.

client_id

str

Erforderlich

Die OAuth-Client-ID der aufrufenden Anwendung.

resource

str

Erforderlich

Ein URI, der die Ressource identifiziert, für die das Token gültig ist.

client_secret

str

Standardwert: None

(optional) Der geheime OAuth-Clientschlüssel der aufrufenden Anwendung.

Gibt zurück

dict mit mehreren Schlüsseln, enthalten "accessToken" und "refreshToken".

acquire_token_with_username_password

Ruft ein Token für eine bestimmte Ressource über Benutzerspalten ab.

acquire_token_with_username_password(resource, username, password, client_id)

Parameter

resource

str

Erforderlich

Ein URI, der die Ressource identifiziert, für die das Token gültig ist.

username

str

Erforderlich

Der Benutzername des Benutzers im Namen dieser Anwendung authentifiziert sich.

password

str

Erforderlich

Das Kennwort des Benutzers, der im Username-Parameter benannt ist.

client_id

str

Erforderlich

Die OAuth-Client-ID der aufrufenden Anwendung.

Gibt zurück

dict mit mehreren Schlüsseln, enthalten "accessToken" und "refreshToken".

acquire_user_code

Ruft die Benutzercodeinformationen ab, die user_code enthalten, device_code für die Authentifizierung des Benutzers auf dem Gerät.

acquire_user_code(resource, client_id, language=None)

Parameter

resource

str

Erforderlich

Ein URI, der die Ressource angibt, für die der device_code und user_code gültig ist.

client_id

str

Erforderlich

Die OAuth-Client-ID der aufrufenden Anwendung.

language

str

Standardwert: None

Der Sprachcode, der angibt, wie die Nachricht lokalisiert werden soll.

Gibt zurück

dict enthält Code und URI für Benutzer, die sich über den Browser anmelden können.

cancel_request_to_get_token_with_device_code

Bricht die Abrufanforderung ab, um das Token mit Gerätecode abzurufen.

cancel_request_to_get_token_with_device_code(user_code_info)

Parameter

user_code_info

dict

Erforderlich

Die Codeinformationen aus dem Aufruf von "acquire_user_code"

Gibt zurück

Keine

Attribute

options