Compartir a través de

OnBehalfOfCredential class

  • Referencia
Paquete:
@azure/identity

Habilita la autenticación para Microsoft Entra ID mediante el flujo En nombre de .

Constructores

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crea una instancia de OnBehalfOfCredential con los detalles necesarios para autenticarse en Microsoft Entra ID con la ruta de acceso a un certificado PEM y una aserción de usuario.

Ejemplo de uso de KeyClient from @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)

Crea una instancia de OnBehalfOfCredential con los detalles necesarios para autenticarse en Microsoft Entra ID con un secreto de cliente y una aserción de usuario.

Ejemplo de uso de KeyClient from @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");

Métodos

getToken(string | string[], GetTokenOptions)

Se autentica con Microsoft Entra ID y devuelve un token de acceso si se ejecuta correctamente. Si se produce un error en la autenticación, se producirá un credentialUnavailableError con los detalles del error.

Detalles del constructor

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crea una instancia de OnBehalfOfCredential con los detalles necesarios para autenticarse en Microsoft Entra ID con la ruta de acceso a un certificado PEM y una aserción de usuario.

Ejemplo de uso de KeyClient from @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)

Parámetros

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parámetros opcionales, normalmente comunes entre credenciales.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crea una instancia de OnBehalfOfCredential con los detalles necesarios para autenticarse en Microsoft Entra ID con un secreto de cliente y una aserción de usuario.

Ejemplo de uso de KeyClient from @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)

Parámetros

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parámetros opcionales, normalmente comunes entre credenciales.

Detalles del método

getToken(string | string[], GetTokenOptions)

Se autentica con Microsoft Entra ID y devuelve un token de acceso si se ejecuta correctamente. Si se produce un error en la autenticación, se producirá un credentialUnavailableError con los detalles del error.

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

Parámetros

scopes

string | string[]

Lista de ámbitos a los que tendrá acceso el token.

options
GetTokenOptions

Las opciones usadas para configurar las solicitudes de red subyacentes.

Devoluciones

Promise<AccessToken>