ClientCertificateCredential class

Paquete:

@azure/identity

Habilita la autenticación a Microsoft Entra ID mediante un certificado codificado en PEM que se asigna a un registro de aplicaciones. Puede encontrar más información sobre cómo configurar la autenticación de certificados aquí:

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

Constructores

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Crea una instancia de ClientCertificateCredential con los detalles necesarios para autenticarse en microsoft Entra ID con un certificado.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Crea una instancia de ClientCertificateCredential con los detalles necesarios para autenticarse en microsoft Entra ID con un certificado.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Crea una instancia de ClientCertificateCredential con los detalles necesarios para autenticarse en microsoft Entra ID con un certificado.

Métodos

getToken(string | string[], GetTokenOptions)

Se autentica con el identificador de Entra de Microsoft y devuelve un token de acceso si se ejecuta correctamente. Si se produce un error en la autenticación, se producirá una credentialUnavailableError con los detalles del error.

Detalles del constructor

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Crea una instancia de ClientCertificateCredential con los detalles necesarios para autenticarse en microsoft Entra ID con un certificado.

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

Parámetros

tenantId

string

Identificador de inquilino (directorio) de Microsoft Entra.

clientId

string

Identificador de cliente (aplicación) de un registro de aplicaciones en el inquilino.

configuration

ClientCertificatePEMCertificate

Otros parámetros necesarios, incluido el certificado codificado en PEM como una cadena. Si se omite el tipo, se producirá el valor del certificado codificado en PEM.

options

ClientCertificateCredentialOptions

Opciones para configurar el cliente que realiza la solicitud de autenticación.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Crea una instancia de ClientCertificateCredential con los detalles necesarios para autenticarse en microsoft Entra ID con un certificado.

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

Parámetros

tenantId

string

Identificador de inquilino (directorio) de Microsoft Entra.

clientId

string

Identificador de cliente (aplicación) de un registro de aplicaciones en el inquilino.

configuration

ClientCertificatePEMCertificatePath

Otros parámetros necesarios, incluida la ruta de acceso del certificado en el sistema de archivos. Si se omite el tipo, se producirá el valor de la ruta de acceso a un certificado PEM.

options

ClientCertificateCredentialOptions

Opciones para configurar el cliente que realiza la solicitud de autenticación.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Crea una instancia de ClientCertificateCredential con los detalles necesarios para autenticarse en microsoft Entra ID con un certificado.

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

Parámetros

tenantId

string

Identificador de inquilino (directorio) de Microsoft Entra.

clientId

string

Identificador de cliente (aplicación) de un registro de aplicaciones en el inquilino.

certificatePath

string

Ruta de acceso a un certificado de clave pública o privada codificado en PEM en el sistema de archivos. Asegúrese de que el certificado esté en formato PEM y contenga las claves pública y privada.

options

ClientCertificateCredentialOptions

Opciones para configurar el cliente que realiza la solicitud de autenticación.

Detalles del método

getToken(string | string[], GetTokenOptions)

Se autentica con el identificador de Entra de Microsoft y devuelve un token de acceso si se ejecuta correctamente. Si se produce un error en la autenticación, se producirá una credentialUnavailableError con los detalles del error.

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

Parámetros

scopes

string | string[]

Lista de ámbitos para los que el token tendrá acceso.

options

GetTokenOptions

Las opciones que se usan para configurar las solicitudes que puede realizar esta implementación de TokenCredential.

Devoluciones

Promise<AccessToken>