Share via

OnBehalfOfCredential class

  • Odwołanie
Pakiet:
@azure/identity

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu przepływu W imieniu.

Konstruktory

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Tworzy wystąpienie obiektu OnBehalfOfCredential ze szczegółami wymaganymi do uwierzytelnienia względem Tożsamość Microsoft Entra ze ścieżką do certyfikatu PEM i asercją użytkownika.

Przykład użycia polecenia KeyClient from @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");
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Tworzy wystąpienie obiektu OnBehalfOfCredential ze szczegółami wymaganymi do uwierzytelnienia w Tożsamość Microsoft Entra przy użyciu wpisu tajnego klienta i asercji użytkownika.

Przykład użycia polecenia KeyClient from @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");

Metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami niepowodzenia.

Szczegóły konstruktora

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Tworzy wystąpienie obiektu OnBehalfOfCredential ze szczegółami wymaganymi do uwierzytelnienia względem Tożsamość Microsoft Entra ze ścieżką do certyfikatu PEM i asercją użytkownika.

Przykład użycia polecenia KeyClient from @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)

Parametry

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parametry opcjonalne, zwykle wspólne dla poświadczeń.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Tworzy wystąpienie obiektu OnBehalfOfCredential ze szczegółami wymaganymi do uwierzytelnienia w Tożsamość Microsoft Entra przy użyciu wpisu tajnego klienta i asercji użytkownika.

Przykład użycia polecenia KeyClient from @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)

Parametry

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parametry opcjonalne, zwykle wspólne dla poświadczeń.

Szczegóły metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami niepowodzenia.

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

Parametry

scopes

string | string[]

Lista zakresów, dla których token będzie miał dostęp.

options
GetTokenOptions

Opcje używane do konfigurowania podstawowych żądań sieciowych.

Zwraca

Promise<AccessToken>