OnBehalfOfCredential class
Включает проверку подлинности для Microsoft Entra ID с помощью потока On Behalf Of.
Конструкторы
On |
Создает экземпляр OnBehalfOfCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с путем к сертификату PEM и утверждением пользователя. Пример использования
|
On |
Создает экземпляр OnBehalfOfCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с секретом клиента и утверждением пользователя. Пример использования
|
Методы
get |
Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError со сведениями о сбое. |
Сведения о конструкторе
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Создает экземпляр OnBehalfOfCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с путем к сертификату PEM и утверждением пользователя.
Пример использования KeyClient
из @azure/keyvault-keys:
const tokenCredential = new OnBehalfOfCredential({
tenantId,
clientId,
certificatePath: "/path/to/certificate.pem",
userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);
await client.getKey("key-name");
new OnBehalfOfCredential(options: OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Параметры
- options
-
OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions
Необязательные параметры, обычно общие для учетных данных.
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Создает экземпляр OnBehalfOfCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с секретом клиента и утверждением пользователя.
Пример использования KeyClient
из @azure/keyvault-keys:
const tokenCredential = new OnBehalfOfCredential({
tenantId,
clientId,
clientSecret,
userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);
await client.getKey("key-name");
new OnBehalfOfCredential(options: OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Параметры
- options
-
OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions
Необязательные параметры, обычно общие для учетных данных.
Сведения о методе
getToken(string | string[], GetTokenOptions)
Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError со сведениями о сбое.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>
Параметры
- scopes
-
string | string[]
Список областей, доступ к которым будет иметь маркер.
- options
- GetTokenOptions
Параметры, используемые для настройки базовых сетевых запросов.
Возвращаемое значение
Promise<AccessToken>