AuthorizationCodeCredential class
Permite a autenticação para o Microsoft Entra ID usando um código de autorização que foi obtido através do 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 que foi obtida do Microsoft Entra ID. Atualmente, é necessário que o usuário dessa credencial inicie o fluxo do 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 que foi obtida do Microsoft Entra ID. Atualmente, é necessário que o usuário dessa credencial inicie o fluxo do 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 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
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 que foi obtida do Microsoft Entra ID.
Atualmente, é necessário que o usuário dessa credencial inicie o fluxo do 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 nome ou ID do locatário (diretório) do Microsoft Entra. 'comum' pode ser usado ao lidar com cenários multilocatário.
- clientId
-
string
O ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.
- authorizationCode
-
string
Um código de autorização que foi recebido seguindo o fluxo de código de autorização. Esse código de autorização não deve já ter sido usado para obter um token de acesso.
- redirectUri
-
string
O URI de redirecionamento que foi usado para solicitar o código de autorização. Deve ser o mesmo URI configurado para o Registro do 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 que foi obtida do Microsoft Entra ID.
Atualmente, é necessário que o usuário dessa credencial inicie o fluxo do 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 nome ou ID do locatário (diretório) do Microsoft Entra. 'comum' pode ser usado ao lidar com cenários multilocatário.
- clientId
-
string
O ID do cliente (aplicativo) de um Registro de Aplicativo no locatário.
- clientSecret
-
string
Um segredo do cliente que foi gerado para o Registo da Aplicação
- authorizationCode
-
string
Um código de autorização que foi recebido seguindo o fluxo de código de autorização. Esse código de autorização não deve já ter sido usado para obter um token de acesso.
- redirectUri
-
string
O URI de redirecionamento que foi usado para solicitar o código de autorização. Deve ser o mesmo URI configurado para o Registro do aplicativo.
Opções para configurar o cliente que faz a solicitação de token de acesso.
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 quaisquer solicitações que essa implementação de TokenCredential possa fazer.
Devoluções
Promise<AccessToken>