OnBehalfOfCredential class
Maakt authenticatie mogelijk om te Microsoft Entra ID met behulp van de Namens de flow.
Constructors
| On |
Maakt een instantie aan van de OnBehalfOfCredential met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met een client Voorbeeld van het gebruik van de
|
| On |
Maakt een instantie aan van de OnBehalfOfCredential met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met pad naar een PEM-certificaat en een gebruikersassertie. Voorbeeld van het gebruik van de
|
| On |
Maakt een instantie aan van de OnBehalfOfCredential met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met een client secret en een gebruikersassertie. Voorbeeld van het gebruik van de
|
Methoden
| get |
Authenticeert met Microsoft Entra ID en geeft een toegangstoken terug als het lukt. Als de verificatie mislukt, wordt een CredentialUnavailableError- gegenereerd met de details van de fout. |
Constructordetails
OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Maakt een instantie aan van de OnBehalfOfCredential met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met een client getAssertion en een user assertion.
Voorbeeld van het gebruik van de KeyClient van @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)
Parameters
- options
-
OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions
Optionele parameters, over het algemeen gebruikelijk voor referenties.
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Maakt een instantie aan van de OnBehalfOfCredential met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met pad naar een PEM-certificaat en een gebruikersassertie.
Voorbeeld van het gebruik van de KeyClient van @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)
Parameters
- options
-
OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions
Optionele parameters, over het algemeen gebruikelijk voor referenties.
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Maakt een instantie aan van de OnBehalfOfCredential met de gegevens die nodig zijn om te authenticeren tegen Microsoft Entra ID met een client secret en een gebruikersassertie.
Voorbeeld van het gebruik van de KeyClient van @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)
Parameters
- options
-
OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions
Optionele parameters, over het algemeen gebruikelijk voor referenties.
Methodedetails
getToken(string | string[], GetTokenOptions)
Authenticeert met Microsoft Entra ID en geeft een toegangstoken terug als het 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>