Delen via

OnBehalfOfCredential class

  • Referentie
Pakket:
@azure/identity

Hiermee schakelt u verificatie voor Microsoft Entra-id in met behulp van de Namens stroom.

Constructors

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Hiermee maakt u een exemplaar van de OnBehalfOfCredential- met de details die nodig zijn voor verificatie bij Microsoft Entra ID met een client getAssertion en een gebruikersverklaring.

Voorbeeld van het gebruik van de KeyClient van @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)

Hiermee maakt u een exemplaar van de OnBehalfOfCredential- met de details die nodig zijn om te verifiëren bij Microsoft Entra ID met pad naar een PEM-certificaat en een gebruikersverklaring.

Voorbeeld van het gebruik van de KeyClient van @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)

Hiermee maakt u een exemplaar van de OnBehalfOfCredential- met de details die nodig zijn voor verificatie bij Microsoft Entra ID met een clientgeheim en een gebruikersverklaring.

Voorbeeld van het gebruik van de KeyClient van @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");

Methoden

getToken(string | string[], GetTokenOptions)

Verifieert met Microsoft Entra-id en retourneert een toegangstoken als dit lukt. Als de verificatie mislukt, wordt een CredentialUnavailableError- gegenereerd met de details van de fout.

Constructordetails

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Hiermee maakt u een exemplaar van de OnBehalfOfCredential- met de details die nodig zijn voor verificatie bij Microsoft Entra ID met een client getAssertion en een gebruikersverklaring.

Voorbeeld van het gebruik van de KeyClient van @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)

Parameters

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Optionele parameters, over het algemeen gebruikelijk voor referenties.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Hiermee maakt u een exemplaar van de OnBehalfOfCredential- met de details die nodig zijn om te verifiëren bij Microsoft Entra ID met pad naar een PEM-certificaat en een gebruikersverklaring.

Voorbeeld van het gebruik van de KeyClient van @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)

Parameters

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Optionele parameters, over het algemeen gebruikelijk voor referenties.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Hiermee maakt u een exemplaar van de OnBehalfOfCredential- met de details die nodig zijn voor verificatie bij Microsoft Entra ID met een clientgeheim en een gebruikersverklaring.

Voorbeeld van het gebruik van de KeyClient van @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)

Parameters

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Optionele parameters, over het algemeen gebruikelijk voor referenties.

Methodedetails

getToken(string | string[], GetTokenOptions)

Verifieert met Microsoft Entra-id en retourneert een toegangstoken als dit lukt. Als de verificatie mislukt, wordt een CredentialUnavailableError- gegenereerd met de details van de fout.

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

Parameters

scopes

string | string[]

De lijst met bereiken waartoe het token toegang heeft.

options
GetTokenOptions

De opties die worden gebruikt om de onderliggende netwerkaanvragen te configureren.

Retouren

Promise<AccessToken>