OnBehalfOfCredentialBuilder 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.OnBehalfOfCredentialBuilder

public class OnBehalfOfCredentialBuilder
extends AadCredentialBuilderBase<OnBehalfOfCredentialBuilder>

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

Au nom de l’authentification dans Azure est un moyen pour un utilisateur ou une application de s’authentifier auprès d’un service ou d’une ressource à l’aide des informations d’identification d’un autre fournisseur d’identité. Ce type d’authentification est généralement utilisé lorsqu’un utilisateur ou une application souhaite accéder à une ressource dans Azure, mais que ses informations d’identification sont gérées par un autre fournisseur d’identité, tel qu’un Active Directory local ou un fournisseur d’identité tiers. Pour utiliser l’authentification « Au nom de » dans Azure, l’utilisateur doit d’abord s’authentifier auprès du fournisseur d’identité à l’aide de ses informations d’identification. Le fournisseur d’identité émet ensuite un jeton de sécurité qui contient des informations sur l’utilisateur et ses autorisations. Ce jeton de sécurité est ensuite passé à Azure, qui l’utilise pour authentifier l’utilisateur ou l’application et lui accorder l’accès à la ressource demandée. OnBehalfOfCredential acquiert un jeton avec une clé secrète/certificat client et une assertion utilisateur pour une application AAD pour le compte d’un principal d’utilisateur.

L’exemple de code suivant illustre la création d’un OnBehalfOfCredential, à l’aide de pour le OnBehalfOfCredentialBuilder configurer. Les tenantIdparamètres et clientSecretclientId sont requis pour créer OnBehalfOfCredential. Peut userAssertion être spécifié éventuellement sur .OnBehalfOfCredentialBuilder 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 onBehalfOfCredential = new OnBehalfOfCredentialBuilder()
     .clientId("<app-client-ID>")
     .clientSecret("<app-Client-Secret>")
     .tenantId("<app-tenant-ID>")
     .userAssertion("<user-assertion>")
     .build();

Récapitulatif du constructeur

Constructeur	Description
OnBehalfOfCredentialBuilder()

Résumé de la méthode

Modificateur et type	Méthode et description
OnBehalfOfCredential	build() Crée un nouveau OnBehalfOfCredential avec les configurations actuelles.
OnBehalfOfCredentialBuilder	clientCertificatePassword(String clientCertificatePassword) Définit le mot de passe du certificat client pour l’authentification auprès d’AAD.
OnBehalfOfCredentialBuilder	clientSecret(String clientSecret) Définit la clé secrète client pour l’authentification.
OnBehalfOfCredentialBuilder	pemCertificate(String pemCertificatePath) Définit le chemin d’accès du certificat PEM pour l’authentification auprès d’AAD.
OnBehalfOfCredentialBuilder	pfxCertificate(String pfxCertificatePath) Définit le chemin d’accès et le mot de passe du certificat PFX pour l’authentification auprès d’AAD.
OnBehalfOfCredentialBuilder	sendCertificateChain(boolean sendCertificateChain) Spécifie si la revendication x5c (clé publique du certificat) doit être envoyée dans le cadre de la demande d’authentification et activer l’authentification basée sur le nom de l’objet/l’émetteur.
OnBehalfOfCredentialBuilder	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.
OnBehalfOfCredentialBuilder	userAssertion(String userAssertion) Configurez l’étendue d’assertion utilisateur à utiliser pour la demande d’authentification Aunomde l’utilisateur.

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

OnBehalfOfCredentialBuilder

public OnBehalfOfCredentialBuilder()

Détails de la méthode

build

public OnBehalfOfCredential build()

Crée un nouveau OnBehalfOfCredential avec les configurations actuelles.

Returns:

avec OnBehalfOfCredential les configurations actuelles.

clientCertificatePassword

public OnBehalfOfCredentialBuilder clientCertificatePassword(String clientCertificatePassword)

Définit le mot de passe du certificat client pour l’authentification auprès d’AAD.

Parameters:

clientCertificatePassword - le mot de passe protégeant le certificat

Returns:

Une instance mise à jour de ce générateur.

clientSecret

public OnBehalfOfCredentialBuilder clientSecret(String clientSecret)

Définit la clé secrète client pour l’authentification.

Parameters:

clientSecret - valeur secrète de l’application AAD.

Returns:

Une instance mise à jour de ce générateur.

pemCertificate

public OnBehalfOfCredentialBuilder pemCertificate(String pemCertificatePath)

Définit le chemin d’accès du certificat PEM pour l’authentification auprès d’AAD.

Parameters:

pemCertificatePath - fichier PEM contenant le certificat

Returns:

Une instance mise à jour de ce générateur.

pfxCertificate

public OnBehalfOfCredentialBuilder pfxCertificate(String pfxCertificatePath)

Définit le chemin d’accès et le mot de passe du certificat PFX pour l’authentification auprès d’AAD.

Parameters:

pfxCertificatePath - fichier PFX protégé par mot de passe contenant le certificat

Returns:

Une instance mise à jour de ce générateur.

sendCertificateChain

public OnBehalfOfCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

Spécifie si la revendication x5c (clé publique du certificat) doit être envoyée dans le cadre de la demande d’authentification et activer l’authentification basée sur le nom de l’objet/l’émetteur. La valeur par défaut est false.

Parameters:

sendCertificateChain - indicateur indiquant si la chaîne de certificats doit être envoyée dans le cadre de la demande d’authentification.

Returns:

Une instance mise à jour de ce générateur.

tokenCachePersistenceOptions

public OnBehalfOfCredentialBuilder 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.

userAssertion

public OnBehalfOfCredentialBuilder userAssertion(String userAssertion)

Configurez l’étendue d’assertion utilisateur à utiliser pour la demande d’authentification OnBehalfOf.

Parameters:

userAssertion - jeton d’accès d’assertion utilisateur à utiliser pour le flux d’authentification De la part de l’utilisateur

Returns:

Une instance mise à jour de ce générateur avec l’étendue d’assertion utilisateur configurée.