AuthorizationCodeCredential class

Permite que a autenticação Microsoft Entra ID através de um código de autorização obtido através do fluxo de código de autorização, descrito mais detalhadamente na documentação do Microsoft Entra ID:

https://video2.skills-academy.com/entra/identity-platform/v2-oauth2-auth-code-flow

Construtores

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

Cria uma instância de AuthorizationCodeCredential com os detalhes necessários para pedir um token de acesso através de uma autenticação obtida a partir de Microsoft Entra ID.

Atualmente, é necessário que o utilizador desta credencial inicie o fluxo de código de autorização para obter um código de autorização para ser utilizado com esta credencial. É fornecido um exemplo completo deste fluxo aqui:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

Cria uma instância de AuthorizationCodeCredential com os detalhes necessários para pedir um token de acesso através de uma autenticação obtida a partir de Microsoft Entra ID.

Atualmente, é necessário que o utilizador desta credencial inicie o fluxo de código de autorização para obter um código de autorização para ser utilizado com esta credencial. É fornecido um exemplo completo deste fluxo aqui:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

Métodos

getToken(string | string[], GetTokenOptions)

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

Detalhes do Construtor

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

Cria uma instância de AuthorizationCodeCredential com os detalhes necessários para pedir um token de acesso através de uma autenticação obtida a partir de Microsoft Entra ID.

Atualmente, é necessário que o utilizador desta credencial inicie o fluxo de código de autorização para obter um código de autorização para ser utilizado com esta credencial. É fornecido um exemplo completo deste fluxo aqui:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

Parâmetros

tenantId

string

O ID ou nome do inquilino Microsoft Entra (diretório). Pode ser utilizado "comum" ao lidar com cenários multi-inquilinos.

clientId

string

O ID de cliente (aplicação) de um Registo de Aplicações no inquilino.

authorizationCode

string

Um código de autorização recebido a partir do seguinte fluxo de código de autorização. Este código de autorização não pode já ter sido utilizado para obter um token de acesso.

redirectUri

string

O URI de redirecionamento que foi utilizado para pedir o código de autorização. Tem de ser o mesmo URI que está configurado para o Registo de Aplicações.

options
AuthorizationCodeCredentialOptions

Opções para configurar o cliente que faz o pedido de token de acesso.

AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

Cria uma instância de AuthorizationCodeCredential com os detalhes necessários para pedir um token de acesso através de uma autenticação obtida a partir de Microsoft Entra ID.

Atualmente, é necessário que o utilizador desta credencial inicie o fluxo de código de autorização para obter um código de autorização para ser utilizado com esta credencial. É fornecido um exemplo completo deste fluxo aqui:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

Parâmetros

tenantId

string

O ID ou nome do inquilino Microsoft Entra (diretório). Pode ser utilizado "comum" ao lidar com cenários multi-inquilinos.

clientId

string

O ID de cliente (aplicação) de um Registo de Aplicações no inquilino.

clientSecret

string

Um segredo do cliente que foi gerado para o Registo de Aplicações

authorizationCode

string

Um código de autorização recebido a partir do seguinte fluxo de código de autorização. Este código de autorização não pode já ter sido utilizado para obter um token de acesso.

redirectUri

string

O URI de redirecionamento que foi utilizado para pedir o código de autorização. Tem de ser o mesmo URI que está configurado para o Registo de Aplicações.

options
AuthorizationCodeCredentialOptions

Opções para configurar o cliente que faz o pedido de token de acesso.

Detalhes de Método

getToken(string | string[], GetTokenOptions)

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

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

Parâmetros

scopes

string | string[]

A lista de âmbitos aos quais o token terá acesso.

options
GetTokenOptions

As opções utilizadas para configurar quaisquer pedidos que esta implementação TokenCredential possa fazer.

Devoluções

Promise<AccessToken>