DeviceCodeCredentialBuilder Classe

Paquet:

com.azure.identity

Artefact Maven:

com.azure:azure-identity:1.10.4

• java.lang.Object
• • com.azure.identity.CredentialBuilderBase<T>
  • • com.azure.identity.AadCredentialBuilderBase<T>
    • • com.azure.identity.DeviceCodeCredentialBuilder

public class DeviceCodeCredentialBuilder
extends AadCredentialBuilderBase<DeviceCodeCredentialBuilder>

Générateur d’informations d’identification Fluent pour l’instanciation d’un DeviceCodeCredential.

L’authentification par code d’appareil est un type de flux d’authentification proposé par Azure Active Directory (Azure AD) qui permet aux utilisateurs de se connecter à des applications sur des appareils qui n’ont pas de navigateur web ou de clavier. Cette méthode d’authentification est particulièrement utile pour les appareils tels que les téléviseurs intelligents, les consoles de jeu et les appareils Internet des objets (IoT) qui n’ont peut-être pas la possibilité d’entrer un nom d’utilisateur et un mot de passe. Avec l’authentification par code d’appareil, l’utilisateur reçoit un code d’appareil sur l’appareil qui doit être authentifié. L’utilisateur accède ensuite à un navigateur web sur un appareil distinct et entre le code dans la page de connexion Microsoft. Une fois que l’utilisateur a entré le code, Azure AD le vérifie et invite l’utilisateur à se connecter avec ses informations d’identification, telles qu’un nom d’utilisateur et un mot de passe ou une méthode d’authentification multifacteur (MFA). L’authentification par code d’appareil peut être lancée à l’aide de différents protocoles pris en charge par Azure AD, tels que OAuth 2.0 et OpenID Connect, et elle peut être utilisée avec un large éventail d’applications intégrées à Azure AD. DeviceCodeCredential authentifie de manière interactive un utilisateur et acquiert un jeton sur les appareils avec une interface utilisateur limitée. Cette méthode invite l’utilisateur à visiter une URL de connexion sur un ordinateur compatible avec un navigateur lorsque l’application tente de s’authentifier. L’utilisateur entre ensuite le code d’appareil mentionné dans les instructions ainsi que ses informations de connexion. Une fois l’authentification réussie, l’application qui a demandé l’authentification est correctement authentifiée sur l’appareil sur lequel elle s’exécute. Pour plus d’informations, reportez-vous aux connaissances conceptuelles et aux détails de configuration.

Ces étapes permettent à l’application de s’authentifier, mais elle n’a toujours pas l’autorisation de vous connecter à Active Directory ou d’accéder à des ressources en votre nom. Pour résoudre ce problème, accédez à Autorisations d’API, puis activez Microsoft Graph et les ressources auxquelles vous souhaitez accéder, par exemple Management des services Azure, Key Vault, etc. Vous devez également être administrateur de votre locataire pour accorder votre consentement à votre application lorsque vous vous connectez pour la première fois. Si vous ne pouvez pas configurer l’option du flux de code d’appareil sur votre Active Directory, il peut être nécessaire que votre application soit mutualisée. Pour que votre application soit multi-locataire, accédez au panneau Authentification, puis sélectionnez Comptes dans n’importe quel annuaire d’organisation. Sélectionnez Oui pour Considérer l’application comme un client public.

Exemple : Construire DeviceCodeCredential

L’exemple de code suivant illustre la création d’un DeviceCodeCredential, à l’aide de pour le DeviceCodeCredentialBuilder configurer. Par défaut, les informations d’identification impriment la requête de code d’appareil sur la ligne de commande, pour remplacer que les comportements d’un challengeConsumer peuvent être spécifiés éventuellement sur le DeviceCodeCredentialBuilder. Une fois ces informations d’identification créées, elles peuvent être transmises au générateur de la plupart des générateurs du kit de développement logiciel (SDK) Azure pour les générateurs de clients Java en tant que paramètre « credential ».

TokenCredential deviceCodeCredential = new DeviceCodeCredentialBuilder()
     .build();

Récapitulatif du constructeur

Constructeur	Description
DeviceCodeCredentialBuilder()

Résumé de la méthode

Modificateur et type	Méthode et description
DeviceCodeCredentialBuilder	additionallyAllowedTenants(String[] additionallyAllowedTenants) Pour les applications mutualisées, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons.
DeviceCodeCredentialBuilder	additionallyAllowedTenants(List<String> additionallyAllowedTenants) Pour les applications mutualisées, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons.
DeviceCodeCredentialBuilder	authenticationRecord(AuthenticationRecord authenticationRecord) Définit le AuthenticationRecord capturé à partir d’une authentification précédente.
DeviceCodeCredential	build() Crée un nouveau DeviceCodeCredential avec les configurations actuelles.
DeviceCodeCredentialBuilder	challengeConsumer(Consumer<DeviceCodeInfo> challengeConsumer) Définit le consommateur pour qu’il réponde au défi du code de l’appareil.
DeviceCodeCredentialBuilder	disableAutomaticAuthentication() Désactive l’authentification automatique et empêche l’invite DeviceCodeCredential automatique de l’utilisateur.
DeviceCodeCredentialBuilder	tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions) Configure les options de cache de jetons partagés persistants et active le cache de jetons persistants qui est désactivé par défaut.

Méthodes héritées de AadCredentialBuilderBase

additionallyAllowedTenants additionallyAllowedTenants authorityHost clientId disableInstanceDiscovery enableUnsafeSupportLogging executorService tenantId

Méthodes héritées de CredentialBuilderBase

addPolicy clientOptions configuration enableAccountIdentifierLogging httpClient httpLogOptions httpPipeline maxRetry pipeline proxyOptions retryOptions retryPolicy retryTimeout

Méthodes héritées de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails du constructeur

DeviceCodeCredentialBuilder

public DeviceCodeCredentialBuilder()

Détails de la méthode

additionallyAllowedTenants

public DeviceCodeCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

Pour les applications mutualisées, spécifie des locataires supplémentaires pour lesquels 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 sur lequel l’application est installée. Si aucune valeur n’est spécifiée pour TenantId, cette option n’aura aucun effet et les informations d’identification acquièrent des jetons pour tout locataire demandé.

Overrides:

DeviceCodeCredentialBuilder.additionallyAllowedTenants(String[] additionallyAllowedTenants)

Parameters:

additionallyAllowedTenants - les locataires autorisés en outre.

Returns:

Une instance mise à jour de ce générateur avec les locataires supplémentaires configurés.

additionallyAllowedTenants

public DeviceCodeCredentialBuilder additionallyAllowedTenants(List additionallyAllowedTenants)

Pour les applications mutualisées, spécifie des locataires supplémentaires pour lesquels 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 sur lequel l’application est installée. Si aucune valeur n’est spécifiée pour TenantId, cette option n’aura aucun effet et les informations d’identification acquièrent des jetons pour tout locataire demandé.

Overrides:

DeviceCodeCredentialBuilder.additionallyAllowedTenants(List<String> additionallyAllowedTenants)

Parameters:

additionallyAllowedTenants - les locataires autorisés en outre.

Returns:

Une instance mise à jour de ce générateur avec les locataires supplémentaires configurés.

authenticationRecord

public DeviceCodeCredentialBuilder authenticationRecord(AuthenticationRecord authenticationRecord)

Définit le AuthenticationRecord capturé à partir d’une authentification précédente.

Parameters:

authenticationRecord - enregistrement d’authentification à configurer.

Returns:

Une instance mise à jour de ce générateur avec l’enregistrement d’authentification configuré.

build

public DeviceCodeCredential build()

Crée un nouveau DeviceCodeCredential avec les configurations actuelles.

Returns:

avec DeviceCodeCredential les configurations actuelles.

challengeConsumer

public DeviceCodeCredentialBuilder challengeConsumer(Consumer challengeConsumer)

Définit le consommateur pour qu’il réponde au défi du code de l’appareil. S’il n’est pas spécifié, un consommateur par défaut est utilisé pour imprimer le message d’informations de code de l’appareil sur stdout.

Parameters:

challengeConsumer - Méthode permettant à l’utilisateur de relever le défi du code de l’appareil.

Returns:

InteractiveBrowserCredentialBuilder lui-même

disableAutomaticAuthentication

public DeviceCodeCredentialBuilder disableAutomaticAuthentication()

Désactive l’authentification automatique et empêche l’invite DeviceCodeCredential automatique de l’utilisateur. Si l’authentification automatique est désactivée, un AuthenticationRequiredException sera levée à partir du getToken(TokenRequestContext request) cas où l’interaction utilisateur est nécessaire. L’application est responsable de la gestion de cette exception et de l’appel authenticate() ou authenticate(TokenRequestContext request) de l’authentification de l’utilisateur de manière interactive.

Returns:

Une instance mise à jour de ce générateur avec l’authentification automatique désactivée.

tokenCachePersistenceOptions

public DeviceCodeCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

Configure les options de cache de jetons partagés persistants et active le cache de jetons persistants qui est désactivé par défaut. Si elles sont configurées, les informations d’identification stockent les jetons dans un cache conservé sur l’ordinateur, protégé pour l’utilisateur actuel, qui peut être partagé par d’autres informations d’identification et processus.

Parameters:

tokenCachePersistenceOptions - options de configuration du cache de jetons

Returns:

Une instance mise à jour de ce générateur avec les options de cache de jeton configurées.