ClientCertificateCredential class

Пакет:

@azure/identity

Позволяет выполнять проверку подлинности для Microsoft Entra ID с помощью сертификата в кодировке PEM, назначенного регистрации приложения. Дополнительные сведения о настройке проверки подлинности на основе сертификата можно найти здесь:

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

Конструкторы

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	Создает экземпляр ClientCertificateCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с помощью сертификата.
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	Создает экземпляр ClientCertificateCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с помощью сертификата.
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	Создает экземпляр ClientCertificateCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с помощью сертификата.

Методы

getToken(string | string[], GetTokenOptions)

Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError с подробными сведениями об ошибке.

Сведения о конструкторе

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)

Создает экземпляр ClientCertificateCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с помощью сертификата.

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

Параметры

tenantId

string

Идентификатор клиента (каталога) Microsoft Entra.

clientId

string

Идентификатор клиента (приложения) регистрации приложения в клиенте.

configuration

ClientCertificatePEMCertificate

Требуются другие параметры, включая сертификат в кодировке PEM в виде строки. Если тип игнорируется, мы выведем значение сертификата в кодировке PEM.

options

ClientCertificateCredentialOptions

Параметры настройки клиента, который выполняет запрос проверки подлинности.

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

Создает экземпляр ClientCertificateCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с помощью сертификата.

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

Параметры

tenantId

string

Идентификатор клиента (каталога) Microsoft Entra.

clientId

string

Идентификатор клиента (приложения) регистрации приложения в клиенте.

configuration

ClientCertificatePEMCertificatePath

Другие необходимые параметры, включая путь к сертификату в файловой системе. Если тип игнорируется, мы выведем значение пути к сертификату PEM.

options

ClientCertificateCredentialOptions

Параметры настройки клиента, который выполняет запрос проверки подлинности.

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

Создает экземпляр ClientCertificateCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с помощью сертификата.

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

Параметры

tenantId

string

Идентификатор клиента (каталога) Microsoft Entra.

clientId

string

Идентификатор клиента (приложения) регистрации приложения в клиенте.

certificatePath

string

Путь к сертификату открытого или закрытого ключа в pem-кодировке в файловой системе.

options

ClientCertificateCredentialOptions

Параметры настройки клиента, который выполняет запрос проверки подлинности.

Сведения о методе

getToken(string | string[], GetTokenOptions)

Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError с подробными сведениями об ошибке.

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

Параметры

scopes

string | string[]

Список областей, для которых у маркера будет доступ.

options

GetTokenOptions

Параметры, используемые для настройки любых запросов, которые может выполнять реализация TokenCredential.

Возвращаемое значение

Promise<AccessToken>