Partilhar via

OnBehalfOfCredential class

  • Referência
Pacote:
@azure/identity

Habilita a autenticação para o Microsoft Entra ID usando o fluxo On Behalf Of.

Construtores

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

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

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

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

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

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

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

Autentica com o ID do Microsoft Entra e retorna um token de acesso se for bem-sucedido. Se a autenticação falhar, uma CredentialUnavailableError será lançada 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 no Microsoft Entra ID com um getAssertion de cliente e uma declaração de usuário.

Exemplo usando o KeyClient 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 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 caminho para um certificado PEM e uma declaração de usuário.

Exemplo usando o KeyClient 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 opcionais, geralmente comuns entre credenciais.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

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

Exemplo usando o KeyClient 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 opcionais, geralmente comuns entre credenciais.

Detalhes de Método

getToken(string | string[], GetTokenOptions)

Autentica com o ID do Microsoft Entra e retorna um token de acesso se for bem-sucedido. Se a autenticação falhar, uma CredentialUnavailableError será lançada 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.

Devoluções

Promise<AccessToken>