Condividi tramite

AuthenticationContext Classe

  • Riferimento

Recupera i token di autenticazione da Azure Active Directory.

Per gli usi, vedere la cartella "sample" in: https://github.com/AzureAD/azure-activedirectory-library-for-python

Crea un nuovo oggetto AuthenticationContext.

Per impostazione predefinita, l'autorità verrà controllata in base a un elenco di autorità di Azure Active Directory note. Se l'autorità non viene riconosciuta come una di queste autorità note, l'acquisizione dei token avrà esito negativo. Questo comportamento può essere disattivato tramite il parametro validate_authority seguente.

Ereditarietà
builtins.object
AuthenticationContext

Costruttore

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

Parametri

authority
str
Necessario

URL che identifica un'autorità token. Deve essere del formato https://login.microsoftonline.com/your_tenant

validate_authority
bool
valore predefinito: None

(facoltativo) Attiva o disattiva la convalida dell'autorità. Questo parametro è true.

cache
TokenCache
valore predefinito: None

(facoltativo) Imposta la cache dei token usata da questa istanza di AuthenticationContext. Se questo parametro non è impostato, viene usato un valore predefinito. Le istanze della cache vengono usate solo da tale istanza di AuthenticationContext e non vengono condivise a meno che non sia stata passata manualmente durante la costruzione di altri AuthenticationContexts.

api_version
valore predefinito: None

(facoltativo) Specifica la versione dell'API usando sul cavo. Storicamente ha un valore predefinito hardcoded come "1.0". Gli sviluppatori sono stati incoraggiati a impostarlo come None in modo esplicito, il che significa che la versione dell'API sottostante verrà scelta automaticamente. A partire da ADAL Python 1.0, questo valore predefinito diventa Nessuno.

timeout
valore predefinito: None

(facoltativo) richiede timeout. Per quanto tempo attendere che il server invii dati prima di rinunciare, come float o una tupla (timeout di connessione, timeout di lettura).

enable_pii
valore predefinito: False

(facoltativo) A meno che non sia impostato su True, non saranno presenti informazioni personali (PII) scritte nel log.

verify_ssl
valore predefinito: None

(facoltativo) richieste di verifica. Un booleano, nel qual caso controlla se si verifica il certificato TLS del server o una stringa, nel qual caso deve essere un percorso di un bundle CA da usare. Se questo valore non viene specificato e ADAL_PYTHON_SSL_NO_VERIFY viene impostato env varaible, il comportamento equivale a verify_ssl=False.

proxies
valore predefinito: None

(facoltativo) richiede proxy. Protocollo di mapping del dizionario all'URL del proxy. Per informazioni dettagliate, vedere http://docs.python-requests.org/en/master/user/advanced/#proxies.

Metodi

acquire_token

Ottiene un token per una determinata risorsa tramite token memorizzati nella cache.
acquire_token_with_authorization_code

Ottiene un token per una determinata risorsa tramite codice di autorizzazione per un'app server.
acquire_token_with_client_certificate

Ottiene un token per una determinata risorsa tramite credenziali del certificato
acquire_token_with_client_credentials

Ottiene un token per una determinata risorsa tramite credenziali client.
acquire_token_with_device_code

Ottiene un nuovo token di accesso tramite un codice del dispositivo.
acquire_token_with_refresh_token

Ottiene un token per una determinata risorsa tramite token di aggiornamento
acquire_token_with_username_password

Ottiene un token per una determinata risorsa tramite l'utente credeails.
acquire_user_code

Ottiene le informazioni sul codice utente che contiene user_code, device_code per l'autenticazione dell'utente nel dispositivo.
cancel_request_to_get_token_with_device_code

Annulla la richiesta di polling per ottenere il token con il codice del dispositivo.

acquire_token

Ottiene un token per una determinata risorsa tramite token memorizzati nella cache.

acquire_token(resource, user_id, client_id)

Parametri

resource
str
Necessario

URI che identifica la risorsa per cui il token è valido.

user_id
str
Necessario

Il nome utente dell'utente per conto di questa applicazione sta autenticando.

client_id
str
Necessario

ID client OAuth dell'applicazione chiamante.

Restituisce

dic con diverse chiavi, includono "accessToken" e "refreshToken".

acquire_token_with_authorization_code

Ottiene un token per una determinata risorsa tramite codice di autorizzazione per un'app server.

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

Parametri

authorization_code
str
Necessario

Codice di autorizzazione restituito da un client.

redirect_uri
str
Necessario

URI di reindirizzamento usato nella chiamata di autorizzazione.

resource
str
Necessario

URI che identifica la risorsa per cui il token è valido.

client_id
str
Necessario

ID client OAuth dell'applicazione chiamante.

client_secret
str
valore predefinito: None

(solo per i client riservati) Segreto client OAuth dell'applicazione chiamante. Questo parametro se non è impostato, per impostazione predefinita none

code_verifier
str
valore predefinito: None

(facoltativo) Verifica del codice usato per ottenere il codice di autorizzazione se PKCE è stato usato nella richiesta di concessione del codice di autorizzazione. (in genere usato dai client pubblici) Questo parametro se non è impostato, per impostazione predefinita none

Restituisce

dict con diverse chiavi, includono "accessToken" e "refreshToken".

acquire_token_with_client_certificate

Ottiene un token per una determinata risorsa tramite credenziali del certificato

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

Parametri

resource
str
Necessario

URI che identifica la risorsa per cui il token è valido.

client_id
str
Necessario

ID client OAuth dell'applicazione chiamante.

certificate
str
Necessario

Chiave privata con codifica PEM.

thumbprint
str
Necessario

identificazione personale con codifica esadecimale del certificato.

public_certificate
valore predefinito: None

se non None, verrà inviato al servizio per l'autenticazione basata su nome soggetto e autorità di certificazione, che è quello di supportare i rolli automatici del certificato. Il valore deve corrispondere al parametro della chiave privata del certificato.

Restituisce

dict con diverse chiavi, includono "accessToken".

acquire_token_with_client_credentials

Ottiene un token per una determinata risorsa tramite credenziali client.

acquire_token_with_client_credentials(resource, client_id, client_secret)

Parametri

resource
str
Necessario

URI che identifica la risorsa per cui il token è valido.

client_id
str
Necessario

ID client OAuth dell'applicazione chiamante.

client_secret
str
Necessario

Segreto client OAuth dell'applicazione chiamante.

Restituisce

dict con diverse chiavi, includono "accessToken".

acquire_token_with_device_code

Ottiene un nuovo token di accesso tramite un codice del dispositivo.

acquire_token_with_device_code(resource, user_code_info, client_id)

Parametri

resource
str
Necessario

URI che identifica la risorsa per cui il token è valido.

user_code_info
dict
Necessario

Informazioni sul codice dalla chiamata di "acquire_user_code"

client_id
str
Necessario

ID client OAuth dell'applicazione chiamante.

Restituisce

dict con diverse chiavi, includono "accessToken" e "refreshToken".

acquire_token_with_refresh_token

Ottiene un token per una determinata risorsa tramite token di aggiornamento

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

Parametri

refresh_token
str
Necessario

Un token di aggiornamento restituito in una risposta tokne da una chiamata precedente di acquireToken.

client_id
str
Necessario

ID client OAuth dell'applicazione chiamante.

resource
str
Necessario

URI che identifica la risorsa per cui il token è valido.

client_secret
str
valore predefinito: None

(facoltativo) Segreto client OAuth dell'applicazione chiamante.

Restituisce

dict con diverse chiavi, includono "accessToken" e "refreshToken".

acquire_token_with_username_password

Ottiene un token per una determinata risorsa tramite l'utente credeails.

acquire_token_with_username_password(resource, username, password, client_id)

Parametri

resource
str
Necessario

URI che identifica la risorsa per cui il token è valido.

username
str
Necessario

Il nome utente dell'utente per conto di questa applicazione sta autenticando.

password
str
Necessario

Password dell'utente denominato nel parametro nome utente.

client_id
str
Necessario

ID client OAuth dell'applicazione chiamante.

Restituisce

dict con diverse chiavi, includono "accessToken" e "refreshToken".

acquire_user_code

Ottiene le informazioni sul codice utente che contiene user_code, device_code per l'autenticazione dell'utente nel dispositivo.

acquire_user_code(resource, client_id, language=None)

Parametri

resource
str
Necessario

URI che identifica la risorsa per cui il device_code e user_code è valido.

client_id
str
Necessario

ID client OAuth dell'applicazione chiamante.

language
str
valore predefinito: None

Codice del linguaggio che specifica come deve essere localizzato il messaggio.

Restituisce

dict contiene codice e uri per gli utenti che accedono tramite browser.

cancel_request_to_get_token_with_device_code

Annulla la richiesta di polling per ottenere il token con il codice del dispositivo.

cancel_request_to_get_token_with_device_code(user_code_info)

Parametri

user_code_info
dict
Necessario

Informazioni sul codice dalla chiamata di "acquire_user_code"

Restituisce

Nessuno

Attributi

options