OnBehalfOfCredential class
Włącza uwierzytelnianie do identyfikatora Entra firmy Microsoft przy użyciu w imieniu przepływu.
Konstruktory
On |
Tworzy wystąpienie OnBehalfOfCredential ze szczegółami wymaganymi do uwierzytelnienia względem identyfikatora Entra firmy Microsoft przy użyciu Przykład użycia
|
On |
Tworzy wystąpienie OnBehalfOfCredential ze szczegółami wymaganymi do uwierzytelnienia względem identyfikatora Entra firmy Microsoft ze ścieżką do certyfikatu PEM i potwierdzeniem użytkownika. Przykład użycia
|
On |
Tworzy wystąpienie OnBehalfOfCredential ze szczegółami wymaganymi do uwierzytelnienia w identyfikatorze Entra firmy Microsoft przy użyciu wpisu tajnego klienta i asercji użytkownika. Przykład użycia
|
Metody
get |
Uwierzytelnia się przy użyciu identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu. |
Szczegóły konstruktora
OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Tworzy wystąpienie OnBehalfOfCredential ze szczegółami wymaganymi do uwierzytelnienia względem identyfikatora Entra firmy Microsoft przy użyciu getAssertion
klienta i asercji użytkownika.
Przykład użycia 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
Parametry opcjonalne, zwykle wspólne dla poświadczeń.
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Tworzy wystąpienie OnBehalfOfCredential ze szczegółami wymaganymi do uwierzytelnienia względem identyfikatora Entra firmy Microsoft ze ścieżką do certyfikatu PEM i potwierdzeniem użytkownika.
Przykład użycia 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
Parametry opcjonalne, zwykle wspólne dla poświadczeń.
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
Tworzy wystąpienie OnBehalfOfCredential ze szczegółami wymaganymi do uwierzytelnienia w identyfikatorze Entra firmy Microsoft przy użyciu wpisu tajnego klienta i asercji użytkownika.
Przykład użycia 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
Parametry opcjonalne, zwykle wspólne dla poświadczeń.
Szczegóły metody
getToken(string | string[], GetTokenOptions)
Uwierzytelnia się przy użyciu identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.
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>