OnBehalfOfCredential class

Пакет:

@azure/identity

Позволяет аутентификация Microsoft Entra ID с помощью От имени потока.

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

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)	Создаёт экземпляр OnBehalfOfCredential с деталями, необходимыми для аутентификации по Microsoft Entra ID с клиентом getAssertion и пользовательским утверждением. Пример использования KeyClient из @azure/keyvault-keys: import { OnBehalfOfCredential } from "@azure/identity"; import { KeyClient } from "@azure/keyvault-keys"; const tokenCredential = new OnBehalfOfCredential({ tenantId: "tenant-id", clientId: "client-id", getAssertion: () => { return Promise.resolve("my-jwt"); }, userAssertionToken: "access-token", }); const client = new KeyClient("vault-url", tokenCredential); await client.getKey("key-name");
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)	Создаёт экземпляр OnBehalfOfCredential с деталями, необходимыми для аутентификации по Microsoft Entra ID с путём к PEM-сертификату и пользовательским утверждением. Пример использования KeyClient из @azure/keyvault-keys: import { OnBehalfOfCredential } from "@azure/identity"; import { KeyClient } from "@azure/keyvault-keys"; const tokenCredential = new OnBehalfOfCredential({ tenantId: "tenant-id", clientId: "client-id", certificatePath: "/path/to/certificate.pem", userAssertionToken: "access-token", }); const client = new KeyClient("vault-url", tokenCredential); await client.getKey("key-name");
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)	Создаёт экземпляр OnBehalfOfCredential с деталями, необходимыми для аутентификации по Microsoft Entra ID с клиентским секретом и пользовательским утверждением. Пример использования KeyClient из @azure/keyvault-keys: import { OnBehalfOfCredential } from "@azure/identity"; import { KeyClient } from "@azure/keyvault-keys"; const tokenCredential = new OnBehalfOfCredential({ tenantId: "tenant-id", clientId: "client-id", clientSecret: "client-secret", userAssertionToken: "access-token", }); const client = new KeyClient("vault-url", tokenCredential); await client.getKey("key-name");

Методы

getToken(string | string[], GetTokenOptions)

Аутентифицируется с помощью Microsoft Entra ID и при успешном возвращении токена доступа. Если проверка подлинности завершается ошибкой, CredentialUnavailableError будет возникать с подробными сведениями об ошибке.

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

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Создаёт экземпляр OnBehalfOfCredential с деталями, необходимыми для аутентификации по Microsoft Entra ID с клиентом getAssertion и пользовательским утверждением.

Пример использования KeyClient из @azure/keyvault-keys:

import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const tokenCredential = new OnBehalfOfCredential({
  tenantId: "tenant-id",
  clientId: "client-id",
  getAssertion: () => {
    return Promise.resolve("my-jwt");
  },
  userAssertionToken: "access-token",
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");

new OnBehalfOfCredential(options: OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Параметры

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Необязательные параметры, обычно распространенные для учетных данных.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Создаёт экземпляр OnBehalfOfCredential с деталями, необходимыми для аутентификации по Microsoft Entra ID с путём к PEM-сертификату и пользовательским утверждением.

Пример использования KeyClient из @azure/keyvault-keys:

import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const tokenCredential = new OnBehalfOfCredential({
  tenantId: "tenant-id",
  clientId: "client-id",
  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:

import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const tokenCredential = new OnBehalfOfCredential({
  tenantId: "tenant-id",
  clientId: "client-id",
  clientSecret: "client-secret",
  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>