Compartir a través de

OnBehalfOfCredential class

  • Referencia
Paquete:
@azure/identity

Habilita la autenticación en el identificador de Entra de Microsoft mediante el en nombre del flujo.

Constructores

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crea una instancia de onBehalfOfCredential con los detalles necesarios para autenticarse en el identificador de Microsoft Entra con un cliente getAssertion y una aserción de usuario.

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

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

Ejemplo de uso del KeyClient de claves de @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 del onBehalfOfCredential con los detalles necesarios para autenticarse en el id. de Microsoft Entra con un secreto de cliente y una aserción de usuario.

Ejemplo de uso del KeyClient de claves de @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 el identificador de Entra de Microsoft y devuelve un token de acceso si se ejecuta correctamente. Si se produce un error en la autenticación, se producirá una credentialUnavailableError con los detalles del error.

Detalles del constructor

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crea una instancia de onBehalfOfCredential con los detalles necesarios para autenticarse en el identificador de Microsoft Entra con un cliente getAssertion y una aserción de usuario.

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

Parámetros

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parámetros opcionales, normalmente comunes entre credenciales.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

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

Ejemplo de uso del KeyClient de claves de @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 del onBehalfOfCredential con los detalles necesarios para autenticarse en el id. de Microsoft Entra con un secreto de cliente y una aserción de usuario.

Ejemplo de uso del KeyClient de claves de @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 el identificador de Entra de Microsoft y devuelve un token de acceso si se ejecuta correctamente. Si se produce un error en la autenticación, se producirá una credentialUnavailableError con los detalles del error.

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

Parámetros

scopes

string | string[]

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

options
GetTokenOptions

Las opciones usadas para configurar las solicitudes de red subyacentes.

Devoluciones

Promise<AccessToken>