Compartilhar via

OnBehalfOfCredential class

  • Referência
Pacote:
@azure/identity

Habilita a autenticação para a ID do Microsoft Entra usando a de fluxoem nome do fluxo.

Construtores

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Cria uma instância do OnBehalfOfCredential com os detalhes necessários para autenticar na ID do Microsoft Entra com um cliente getAssertion e uma declaração de usuário.

Exemplo usando o KeyClient de @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");
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Cria uma instância do OnBehalfOfCredential com os detalhes necessários para autenticar na ID do Microsoft Entra com o caminho para um certificado PEM e uma declaração de usuário.

Exemplo usando o KeyClient de @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");
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Cria uma instância do OnBehalfOfCredential com os detalhes necessários para autenticar na ID do Microsoft Entra com um segredo do cliente e uma declaração de usuário.

Exemplo usando o KeyClient de @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");

Métodos

getToken(string | string[], GetTokenOptions)

Autentica com a ID do Microsoft Entra e retorna um token de acesso se bem-sucedido. Se a autenticação falhar, um CredentialUnavailableError será gerado com os detalhes da falha.

Detalhes do construtor

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Cria uma instância do OnBehalfOfCredential com os detalhes necessários para autenticar na ID do Microsoft Entra com um cliente getAssertion e uma declaração de usuário.

Exemplo usando o KeyClient de @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)

Parâmetros

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parâmetros opcionais, geralmente comuns entre credenciais.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Cria uma instância do OnBehalfOfCredential com os detalhes necessários para autenticar na ID do Microsoft Entra com o caminho para um certificado PEM e uma declaração de usuário.

Exemplo usando o KeyClient de @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)

Parâmetros

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parâmetros opcionais, geralmente comuns entre credenciais.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Cria uma instância do OnBehalfOfCredential com os detalhes necessários para autenticar na ID do Microsoft Entra com um segredo do cliente e uma declaração de usuário.

Exemplo usando o KeyClient de @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)

Parâmetros

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parâmetros opcionais, geralmente comuns entre credenciais.

Detalhes do método

getToken(string | string[], GetTokenOptions)

Autentica com a ID do Microsoft Entra e retorna um token de acesso se bem-sucedido. Se a autenticação falhar, um CredentialUnavailableError será gerado com os detalhes da falha.

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

Parâmetros

scopes

string | string[]

A lista de escopos para os quais o token terá acesso.

options
GetTokenOptions

As opções usadas para configurar as solicitações de rede subjacentes.

Retornos

Promise<AccessToken>