AuthorizationCodeCredential class
Permite a autenticação do Microsoft Entra ID usando um código de autorização obtido pelo fluxo de código de autorização, descrito com mais detalhes na documentação do Microsoft Entra ID:
https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
Construtores
| Authorization |
Cria uma instância de AuthorizationCodeCredential com os detalhes necessários para solicitar um token de acesso usando uma autenticação obtida do Microsoft Entra ID. No momento, é necessário que o usuário dessa credencial inicie o fluxo de código de autorização para obter um código de autorização a ser usado com essa credencial. Um exemplo completo desse fluxo é fornecido aqui: |
| Authorization |
Cria uma instância de AuthorizationCodeCredential com os detalhes necessários para solicitar um token de acesso usando uma autenticação obtida do Microsoft Entra ID. No momento, é necessário que o usuário dessa credencial inicie o fluxo de código de autorização para obter um código de autorização a ser usado com essa credencial. Um exemplo completo desse fluxo é fornecido aqui: |
Métodos
| get |
Autentica com o Microsoft Entra ID e retorna um token de acesso se for bem-sucedido. Se a autenticação falhar, um CredentialUnavailableError será gerado 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 solicitar um token de acesso usando uma autenticação obtida do Microsoft Entra ID.
No momento, é necessário que o usuário dessa credencial inicie o fluxo de código de autorização para obter um código de autorização a ser usado com essa credencial. Um exemplo completo desse fluxo é fornecido aqui:
new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Parâmetros
- tenantId
-
string
O ID ou nome do locatário (diretório) da Microsoft Entra. 'common' pode ser usado ao lidar com cenários multilocatários.
- clientId
-
string
A ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.
- authorizationCode
-
string
Um código de autorização que foi recebido após o fluxo de código de autorização. Esse código de autorização ainda não deve ter sido usado para obter um token de acesso.
- redirectUri
-
string
O URI de redirecionamento usado para solicitar o código de autorização. Deve ser o mesmo URI configurado para o Registro de Aplicativo.
Opções para configurar o cliente que faz a solicitação de token de acesso.
AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)
Cria uma instância de AuthorizationCodeCredential com os detalhes necessários para solicitar um token de acesso usando uma autenticação obtida do Microsoft Entra ID.
No momento, é necessário que o usuário dessa credencial inicie o fluxo de código de autorização para obter um código de autorização a ser usado com essa credencial. Um exemplo completo desse fluxo é fornecido aqui:
new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)Parâmetros
- tenantId
-
string
O ID ou nome do locatário (diretório) da Microsoft Entra. 'common' pode ser usado ao lidar com cenários multilocatários.
- clientId
-
string
A ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.
- clientSecret
-
string
Um segredo do cliente que foi gerado para o Registro de Aplicativo
- authorizationCode
-
string
Um código de autorização que foi recebido após o fluxo de código de autorização. Esse código de autorização ainda não deve ter sido usado para obter um token de acesso.
- redirectUri
-
string
O URI de redirecionamento usado para solicitar o código de autorização. Deve ser o mesmo URI configurado para o Registro de Aplicativo.
Opções para configurar o cliente que faz a solicitação de token de acesso.
Detalhes do método
getToken(string | string[], GetTokenOptions)
Autentica com o Microsoft Entra ID e retorna um token de acesso se for 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 que essa implementação do TokenCredential pode fazer.
Retornos
Promise<AccessToken>