AuthorizationCodeCredential Classe

Esegue l'autenticazione riscattando un codice di autorizzazione ottenuto in precedenza da Azure Active Directory.

Per altre informazioni sul flusso di autenticazione, vedere la documentazione di Azure Active Directory .

Ereditarietà

azure.identity._internal.get_token_mixin.GetTokenMixin

AuthorizationCodeCredential

Costruttore

AuthorizationCodeCredential(tenant_id: str, client_id: str, authorization_code: str, redirect_uri: str, **kwargs: Any)

Parametri

tenant_id

str

Necessario

ID del tenant di Azure Active Directory dell'applicazione. Chiamato anche l'ID "directory".

client_id

str

Necessario

ID client dell'applicazione

authorization_code

str

Necessario

Codice di autorizzazione dell'accesso dell'utente

redirect_uri

str

Necessario

URI di reindirizzamento dell'applicazione. Deve corrispondere all'URI usato per richiedere il codice di autorizzazione.

authority

str

Autorità di un endpoint di Azure Active Directory, ad esempio "login.microsoftonline.com", l'autorità per il cloud pubblico di Azure ,ovvero l'impostazione predefinita. AzureAuthorityHosts definisce le autorità per altri cloud.

client_secret

str

Uno dei segreti client dell'applicazione. Obbligatorio solo per le app Web e le API Web.

additionally_allowed_tenants

List[str]

Specifica i tenant oltre al "tenant_id" specificato per il quale le credenziali possono acquisire i token. Aggiungere il valore jolly "*" per consentire alle credenziali di acquisire i token per qualsiasi tenant a cui l'applicazione può accedere.

Esempio

Creare un oggetto AuthorizationCodeCredential.

   from azure.identity import AuthorizationCodeCredential

   credential = AuthorizationCodeCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       authorization_code="<auth_code>",
       redirect_uri="<redirect_uri>",
   )

Metodi

close

Chiudere la sessione di trasporto delle credenziali.

get_token

Richiedere un token di accesso per gli ambiti. Questo metodo viene chiamato automaticamente dai client Azure SDK. La prima volta che questo metodo viene chiamato, la credenziale riscatterà il codice di autorizzazione. Nelle chiamate successive le credenziali restituiranno un token di accesso memorizzato nella cache o riscatteranno un token di aggiornamento, se ha acquisito un token di aggiornamento al momento del riscatto del codice di autorizzazione.

close

Chiudere la sessione di trasporto delle credenziali.

close() -> None

get_token

Richiedere un token di accesso per gli ambiti.

Questo metodo viene chiamato automaticamente dai client Azure SDK.

La prima volta che questo metodo viene chiamato, la credenziale riscatterà il codice di autorizzazione. Nelle chiamate successive le credenziali restituiranno un token di accesso memorizzato nella cache o riscatteranno un token di aggiornamento, se ha acquisito un token di aggiornamento al momento del riscatto del codice di autorizzazione.

get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

Parametri

scopes

str

Necessario

ambiti desiderati per il token di accesso. Questo metodo richiede almeno un ambito. Per altre informazioni sugli ambiti, vedere https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

attestazioni aggiuntive richieste nel token, ad esempio quelle restituite nella richiesta di attestazioni di un provider di risorse in seguito a un errore di autorizzazione.

tenant_id

str

tenant facoltativo da includere nella richiesta di token.

Restituisce

Token di accesso con gli ambiti desiderati.

Tipo restituito

AccessToken

Eccezioni

ClientAuthenticationError

autenticazione non riuscita. L'attributo dell'errore message indica un motivo. Qualsiasi risposta di errore da Azure Active Directory è disponibile come attributo dell'errore response .