Aracılığıyla paylaş

OnBehalfOfCredential class

  • Başvuru
Paket:
@azure/identity

Adına akışkullanarak Microsoft Entra Kimliği'ne kimlik doğrulamasını etkinleştirir.

Oluşturucular

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

OnBehalfOfCredential bir istemci getAssertion ve kullanıcı onayıyla Microsoft Entra Kimliği'ne karşı kimlik doğrulaması yapmak için gereken ayrıntıları içeren bir örneği oluşturur.

@azure/keyvault-keysKeyClient kullanma örneği:

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)

OnBehalfOfCredential örneğini, PEM sertifikasının yolu ve kullanıcı onayıyla Microsoft Entra ID'de kimlik doğrulaması yapmak için gereken ayrıntıları içeren bir örnek oluşturur.

@azure/keyvault-keysKeyClient kullanma örneği:

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)

OnBehalfOfCredential bir örneğini oluşturur ve bir istemci gizli dizisi ve kullanıcı onayıyla Microsoft Entra Kimliği'ne karşı kimlik doğrulaması yapmak için gereken ayrıntıları içerir.

@azure/keyvault-keysKeyClient kullanma örneği:

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  clientSecret,
  userAssertionToken: "access-token"
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");

Yöntemler

getToken(string | string[], GetTokenOptions)

Microsoft Entra Kimliği ile kimlik doğrulaması yapar ve başarılı olursa bir erişim belirteci döndürür. Kimlik doğrulaması başarısız olursa, CredentialUnavailableError hatanın ayrıntılarıyla birlikte oluşturulur.

Oluşturucu Ayrıntıları

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

OnBehalfOfCredential bir istemci getAssertion ve kullanıcı onayıyla Microsoft Entra Kimliği'ne karşı kimlik doğrulaması yapmak için gereken ayrıntıları içeren bir örneği oluşturur.

@azure/keyvault-keysKeyClient kullanma örneği:

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)

Parametreler

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

İsteğe bağlı parametreler, genellikle kimlik bilgileri arasında ortaktır.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

OnBehalfOfCredential örneğini, PEM sertifikasının yolu ve kullanıcı onayıyla Microsoft Entra ID'de kimlik doğrulaması yapmak için gereken ayrıntıları içeren bir örnek oluşturur.

@azure/keyvault-keysKeyClient kullanma örneği:

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)

Parametreler

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

İsteğe bağlı parametreler, genellikle kimlik bilgileri arasında ortaktır.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

OnBehalfOfCredential bir örneğini oluşturur ve bir istemci gizli dizisi ve kullanıcı onayıyla Microsoft Entra Kimliği'ne karşı kimlik doğrulaması yapmak için gereken ayrıntıları içerir.

@azure/keyvault-keysKeyClient kullanma örneği:

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)

Parametreler

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

İsteğe bağlı parametreler, genellikle kimlik bilgileri arasında ortaktır.

Yöntem Ayrıntıları

getToken(string | string[], GetTokenOptions)

Microsoft Entra Kimliği ile kimlik doğrulaması yapar ve başarılı olursa bir erişim belirteci döndürür. Kimlik doğrulaması başarısız olursa, CredentialUnavailableError hatanın ayrıntılarıyla birlikte oluşturulur.

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

Parametreler

scopes

string | string[]

Belirtecin erişeceği kapsamların listesi.

options
GetTokenOptions

Temel alınan ağ isteklerini yapılandırmak için kullanılan seçenekler.

Döndürülenler

Promise<AccessToken>