AuthorizationCodeCredential Classe

  • Référence

S’authentifie en échangeant un code d’autorisation précédemment obtenu auprès d’Azure Active Directory.

Pour plus d’informations sur le flux d’authentification, consultez la documentation Azure Active Directory .

Héritage
azure.identity._internal.get_token_mixin.GetTokenMixin
AuthorizationCodeCredential

Constructeur

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

Paramètres

tenant_id
str
Obligatoire

ID du locataire Azure Active Directory de l’application. Également appelé son ID « répertoire ».

client_id
str
Obligatoire

ID client de l’application

authorization_code
str
Obligatoire

Code d’autorisation de la connexion de l’utilisateur

redirect_uri
str
Obligatoire

URI de redirection de l’application. Doit correspondre à l’URI utilisé pour demander le code d’autorisation.

authority
str

Autorité d’un point de terminaison Azure Active Directory, par exemple « login.microsoftonline.com », l’autorité pour le cloud public Azure (qui est la valeur par défaut). AzureAuthorityHosts définit les autorités pour d’autres clouds.

client_secret
str

Une des clés secrètes client de l’application. Obligatoire uniquement pour les applications web et les API web.

additionally_allowed_tenants
List[str]

Spécifie les locataires en plus du « tenant_id » spécifié pour lequel les informations d’identification peuvent acquérir des jetons. Ajoutez la valeur générique « * » pour permettre aux informations d’identification d’acquérir des jetons pour n’importe quel locataire auquel l’application peut accéder.

Exemples

Créez un AuthorizationCodeCredential.


   from azure.identity import AuthorizationCodeCredential

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

Méthodes

close

Fermez la session de transport des informations d’identification.
get_token

Demandez un jeton d’accès pour les étendues.

Cette méthode est appelée automatiquement par les clients du Kit de développement logiciel (SDK) Azure.

La première fois que cette méthode est appelée, les informations d’identification échangent leur code d’autorisation. Lors des appels suivants, les informations d’identification retournent un jeton d’accès mis en cache ou échangent un jeton d’actualisation, si elle a acquis un jeton d’actualisation lors de l’utilisation du code d’autorisation.

close

Fermez la session de transport des informations d’identification.

close() -> None

get_token

Demandez un jeton d’accès pour les étendues.

Cette méthode est appelée automatiquement par les clients du Kit de développement logiciel (SDK) Azure.

La première fois que cette méthode est appelée, les informations d’identification échangent leur code d’autorisation. Lors des appels suivants, les informations d’identification retournent un jeton d’accès mis en cache ou échangent un jeton d’actualisation, si elle a acquis un jeton d’actualisation lors de l’utilisation du code d’autorisation.

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

Paramètres

scopes
str
Obligatoire

étendues souhaitées pour le jeton d’accès. Cette méthode nécessite au moins une étendue. Pour plus d’informations sur les étendues, consultez https://video2.skills-academy.com/azure/active-directory/develop/scopes-oidc.

claims
str

revendications supplémentaires requises dans le jeton, telles que celles retournées dans la contestation de revendications d’un fournisseur de ressources suite à un échec d’autorisation.

tenant_id
str

locataire facultatif à inclure dans la demande de jeton.

Retours

Jeton d’accès avec les étendues souhaitées.

Type de retour

AccessToken

Exceptions

ClientAuthenticationError

échec de l’authentification. L’attribut de l’erreur message donne une raison. Toute réponse d’erreur d’Azure Active Directory est disponible en tant qu’attribut de l’erreur response .