ClientCertificateCredential class

Paquet:

@azure/identity

Permet à l’authentification de Microsoft Entra ID à l’aide d’un certificat encodé pem qui est affecté à une inscription d’application. Vous trouverez plus d’informations sur la configuration de l’authentification par certificat ici :

https://learn.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

Constructeurs

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Crée une instance de ClientCertificateCredential avec les détails nécessaires à l’authentification auprès de Microsoft Entra ID avec un certificat.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Crée une instance de ClientCertificateCredential avec les détails nécessaires à l’authentification auprès de Microsoft Entra ID avec un certificat.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Crée une instance de ClientCertificateCredential avec les détails nécessaires à l’authentification auprès de Microsoft Entra ID avec un certificat.

Méthodes

getToken(string | string[], GetTokenOptions)

S’authentifie avec Microsoft Entra ID et retourne un jeton d’accès en cas de réussite. Si l’authentification échoue, une erreur CredentialUnavailableError est levée avec les détails de l’échec.

Détails du constructeur

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Crée une instance de ClientCertificateCredential avec les détails nécessaires à l’authentification auprès de Microsoft Entra ID avec un certificat.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificate, options?: ClientCertificateCredentialOptions)

Paramètres

tenantId

string

ID de locataire (répertoire) Microsoft Entra.

clientId

string

ID client (application) d’une inscription d’application dans le locataire.

configuration

ClientCertificatePEMCertificate

Autres paramètres requis, notamment le certificat encodé pem sous forme de chaîne. Si le type est ignoré, nous lèverons la valeur du certificat encodé en PEM.

options

ClientCertificateCredentialOptions

Options de configuration du client qui effectue la demande d’authentification.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Crée une instance de ClientCertificateCredential avec les détails nécessaires à l’authentification auprès de Microsoft Entra ID avec un certificat.

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)

Paramètres

tenantId

string

ID de locataire (répertoire) Microsoft Entra.

clientId

string

ID client (application) d’une inscription d’application dans le locataire.

configuration

ClientCertificatePEMCertificatePath

Autres paramètres requis, y compris le chemin du certificat sur le système de fichiers. Si le type est ignoré, nous lèverons la valeur du chemin d’accès à un certificat PEM.

options

ClientCertificateCredentialOptions

Options de configuration du client qui effectue la demande d’authentification.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Crée une instance de ClientCertificateCredential avec les détails nécessaires à l’authentification auprès de Microsoft Entra ID avec un certificat.

new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)

Paramètres

tenantId

string

ID de locataire (répertoire) Microsoft Entra.

clientId

string

ID client (application) d’une inscription d’application dans le locataire.

certificatePath

string

Chemin d’accès à un certificat de clé publique/privée encodé en PEM sur le système de fichiers.

options

ClientCertificateCredentialOptions

Options de configuration du client qui effectue la demande d’authentification.

Détails de la méthode

getToken(string | string[], GetTokenOptions)

S’authentifie avec Microsoft Entra ID et retourne un jeton d’accès en cas de réussite. Si l’authentification échoue, une erreur CredentialUnavailableError est levée avec les détails de l’échec.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Paramètres

scopes

string | string[]

Liste des étendues auxquelles le jeton aura accès.

options

GetTokenOptions

Options utilisées pour configurer toutes les demandes que cette implémentation TokenCredential peut effectuer.

Retours

Promise<AccessToken>