Sdílet prostřednictvím

OnBehalfOfCredential class

  • Reference
Balíček:
@azure/identity

Umožňuje ověřování pro Microsoft Entra ID pomocítoku On Behalf Of .

Konstruktory

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Vytvoří instanci OnBehalfOfCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID pomocí klientského getAssertion a uživatelského kontrolního výrazu.

Příklad použití KeyClient z @azure/keyvault-keys:

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  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)

Vytvoří instanci OnBehalfOfCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID s cestou k certifikátu PEM a kontrolním výrazem uživatele.

Příklad použití KeyClient z @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)

Vytvoří instanci OnBehalfOfCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID pomocí tajného klíče klienta a kontrolního výrazu uživatele.

Příklad použití KeyClient z @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)

Ověří se pomocí ID Microsoft Entra a v případě úspěchu vrátí přístupový token. Pokud se ověření nezdaří, zobrazí se CredentialUnavailableError s podrobnostmi o selhání.

Podrobnosti konstruktoru

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Vytvoří instanci OnBehalfOfCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID pomocí klientského getAssertion a uživatelského kontrolního výrazu.

Příklad použití KeyClient z @azure/keyvault-keys:

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  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)

Parametry

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Volitelné parametry, obecně běžné napříč přihlašovacími údaji.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Vytvoří instanci OnBehalfOfCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID s cestou k certifikátu PEM a kontrolním výrazem uživatele.

Příklad použití KeyClient z @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

Volitelné parametry, obecně běžné napříč přihlašovacími údaji.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Vytvoří instanci OnBehalfOfCredential s podrobnostmi potřebnými k ověření v microsoft Entra ID pomocí tajného klíče klienta a kontrolního výrazu uživatele.

Příklad použití KeyClient z @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

Volitelné parametry, obecně běžné napříč přihlašovacími údaji.

Podrobnosti metody

getToken(string | string[], GetTokenOptions)

Ověří se pomocí ID Microsoft Entra a v případě úspěchu vrátí přístupový token. Pokud se ověření nezdaří, zobrazí se CredentialUnavailableError s podrobnostmi o selhání.

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

Parametry

scopes

string | string[]

Seznam oborů, pro které bude mít token přístup.

options
GetTokenOptions

Možnosti použité ke konfiguraci podkladových síťových požadavků.

Návraty

Promise<AccessToken>