Freigeben über

OnBehalfOfCredential class

  • Referenz
Paket:
@azure/identity

Aktiviert die Authentifizierung für Microsoft Entra-ID mithilfe des Im Auftrag von Fluss.

Konstruktoren

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Erstellt eine Instanz des OnBehalfOfCredential- mit den Details, die für die Authentifizierung bei microsoft Entra-ID mit einem Client-getAssertion und einer Benutzer assertion erforderlich sind.

Beispiel für die Verwendung der KeyClient aus @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)

Erstellt eine Instanz des OnBehalfOfCredential- mit den Details, die zum Authentifizieren bei Microsoft Entra-ID mit Pfad zu einem PEM-Zertifikat und einer Benutzer assertion erforderlich sind.

Beispiel für die Verwendung der KeyClient aus @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)

Erstellt eine Instanz des OnBehalfOfCredential- mit den Details, die für die Authentifizierung bei der Microsoft Entra-ID mit einem geheimen Clientschlüssel und einer Benutzer assertion erforderlich sind.

Beispiel für die Verwendung der KeyClient aus @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)

Authentifiziert sich mit der Microsoft Entra-ID und gibt bei erfolgreicher Ausführung ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst.

Details zum Konstruktor

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Erstellt eine Instanz des OnBehalfOfCredential- mit den Details, die für die Authentifizierung bei microsoft Entra-ID mit einem Client-getAssertion und einer Benutzer assertion erforderlich sind.

Beispiel für die Verwendung der KeyClient aus @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)

Parameter

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Optionale Parameter, die in der Regel über Anmeldeinformationen hinweg verwendet werden.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Erstellt eine Instanz des OnBehalfOfCredential- mit den Details, die zum Authentifizieren bei Microsoft Entra-ID mit Pfad zu einem PEM-Zertifikat und einer Benutzer assertion erforderlich sind.

Beispiel für die Verwendung der KeyClient aus @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)

Parameter

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Optionale Parameter, die in der Regel über Anmeldeinformationen hinweg verwendet werden.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Erstellt eine Instanz des OnBehalfOfCredential- mit den Details, die für die Authentifizierung bei der Microsoft Entra-ID mit einem geheimen Clientschlüssel und einer Benutzer assertion erforderlich sind.

Beispiel für die Verwendung der KeyClient aus @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)

Parameter

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Optionale Parameter, die in der Regel über Anmeldeinformationen hinweg verwendet werden.

Details zur Methode

getToken(string | string[], GetTokenOptions)

Authentifiziert sich mit der Microsoft Entra-ID und gibt bei erfolgreicher Ausführung ein Zugriffstoken zurück. Wenn die Authentifizierung fehlschlägt, wird ein CredentialUnavailableError- mit den Details des Fehlers ausgelöst.

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

Parameter

scopes

string | string[]

Die Liste der Bereiche, für die das Token Zugriff hat.

options
GetTokenOptions

Die Optionen zum Konfigurieren der zugrunde liegenden Netzwerkanforderungen.

Gibt zurück

Promise<AccessToken>