@azure/msal-node package

Classe de erro geral gerada pela biblioteca de MSAL.js.

Classe abstrata base para todas as ClientApplications – pública e confidencial

Declaração do cliente do tipo jwt-bearer usado em fluxos de cliente confidenciais

Erro gerado quando há um erro no código do cliente em execução no navegador.

Erro gerado quando há um erro na configuração da biblioteca de MSAL.js.

Concessão de credencial de cliente OAuth2.0

Essa classe deve ser usada para adquirir tokens para aplicativos cliente confidenciais (webApp, webAPI). Aplicativos cliente confidenciais configurarão segredos do aplicativo, certificados/declarações de cliente conforme aplicável

Essa classe implementa a interface de criptografia do nó MSAL, que permite executar codificação e decodificação base64, gerando GUIDs aleatórios criptograficamente e implementando a Chave de Prova para Código Exchange especificações para o fluxo de código de autorização OAuth usando PKCE (rfc aqui: https://tools.ietf.org/html/rfc7636).

Cliente de código do dispositivo OAuth2.0

Plug-in de cache que serializa dados para o cache e desserializa dados do cache

Erro gerado quando a interação do usuário é necessária.

Classe que facilita o registro em log de mensagens em um local específico.

Classe para inicializar uma identidade gerenciada e identificar o serviço

Cliente on-Behalf-Of

Essa classe deve ser usada para adquirir tokens para aplicativos cliente públicos (desktop, móvel). Aplicativos cliente públicos não são confiáveis para armazenar com segurança os segredos do aplicativo e, portanto, só podem solicitar tokens em nome de um usuário.

Erro gerado quando há um erro com o código do servidor, por exemplo, indisponibilidade.

Gerenciador de cache de token na memória

Essa instância de classe ajuda a controlar as alterações de memória facilitando as decisões de leitura e gravação no cache persistente

Observação do cliente de concessão de senha Oauth2.0: Estamos apenas dando suporte a clientes públicos para concessão de senha e para fins puramente de teste

Interface para o cache que define um getter e setter

Interface para a classe ConfidentialClientApplication definindo as assinaturas da API pública

Interface para LoopbackClient, permitindo substituir o servidor de loopback padrão por uma implementação personalizada.

Interface de rede do cliente para enviar solicitações de back-end.

Interface que define métodos getter para obter chaves usadas para dados de identidade no cache

Interface para a classe PublicClientApplication definindo as assinaturas da API pública

Interface de cache de token para o cliente, dando acesso às APIs de cache

Objeto account com a seguinte assinatura:

• homeAccountId – Identificador de conta inicial para este objeto de conta
• ambiente – Entidade que emitiu o token representado pelo domínio do emissor (por exemplo, login.microsoftonline.com)
• tenantId – ID de locatário completo ou organizacional à qual essa conta pertence
• nome de usuário - preferred_username declaração do id_token que representa essa conta
• localAccountId – Identifer de conta local específica do locatário para esse objeto de conta, geralmente usado em casos herdados
• nome – Nome completo da conta, incluindo nome e nome da família fornecidos
• idToken – token de ID bruto
• idTokenClaims – Objeto contém declarações do token de ID
• nativeAccountId – ID da conta nativa do usuário
• tenantProfiles - Mapa de objetos de perfil de locatário para cada locatário com o qual a conta foi autenticada no navegador
• dataBoundary – Limite de dados extraído de clientInfo

Objeto de entrada para a extensibilidade IAppTokenProvider. A MSAL criará esse objeto, que pode ser usado para ajudar a criar um AppTokenProviderResult.

• correlationId - a ID de correlação associada à solicitação
• tenantId - a ID do locatário para a qual o token deve ser fornecido
• escopos – os escopos para os quais o token deve ser fornecido
• declarações - quaisquer declarações extras que o token deve satisfazer

Objeto de saída para extensibilidade IAppTokenProvider.

• accessToken - o token de acesso real, normalmente no formato JWT, que satisfaz os dados de solicitação AppTokenProviderParameters
• expiresInSeconds - quanto tempo os tokens têm antes da expiração, em segundos. Semelhante ao campo "expires_in" em uma resposta de token do AAD.
• refreshInSeconds - quanto tempo o token tem antes de ser atualizado proativamente. Semelhante ao campo "refresh_in" em uma resposta de token do AAD.

Resultado retornado do ponto de extremidade de token da autoridade.

• uniqueId - oid ou sub declaração do token de ID
• tenantId - tid declaração do token de ID
• escopos – Escopos validados para o respectivo token
• conta – Uma representação de objeto de conta do usuário conectado no momento
• idToken – Token de ID recebido como parte da resposta
• idTokenClaims – declarações de token de ID relevantes para MSAL
• accessToken - Token de acesso ou certificado SSH recebido como parte da resposta
• fromCache – Boolean indicando se o token veio do cache
• expiresOn – objeto Data javascript que representa a expiração relativa do token de acesso
• extExpiresOn – Objeto Data javascript que representa a expiração relativa estendida do token de acesso em caso de interrupção do servidor
• refreshOn – Objeto Data javascript que representa a hora relativa até que um token de acesso seja atualizado
• estado – Valor passado pelo usuário na solicitação
• familyId – Identificador de ID da família, geralmente usado apenas para tokens de atualização
• requestId – ID da solicitação retornada como parte da resposta

Resposta retornada após o processamento da cadeia de caracteres ou fragmento da consulta de resposta de código.

Solicitar objeto passado pelo usuário para adquirir um token do servidor trocando um código de autorização válido (segunda etapa do fluxo de código de autorização OAuth2.0)

• escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
• declarações – uma solicitação de declarações em cadeia de caracteres que será adicionada a todas as chamadas /authorize e /token
• autoridade: - URL da autoridade, o STS (serviço de token de segurança) do qual a MSAL adquirirá tokens. Se a autoridade for definida no objeto de aplicativo cliente, isso substituirá esse valor. Substituir o valor fará com que a validação da autoridade ocorra sempre. Se a mesma autoridade for usada para todas as solicitações, defina no objeto do aplicativo em vez das solicitações.
• correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
• redirectUri – O URI de redirecionamento do seu aplicativo, para o qual a autoridade será redirecionada após o usuário inserir credenciais e consentimentos. Ele deve corresponder exatamente a uma das URIs de redirecionamento que você registrou no portal.
• tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
• código – o authorization_code que o usuário adquiriu na primeira etapa do fluxo.
• codeVerifier - O mesmo code_verifier que foi usado para obter o authorization_code. Necessário se o PKCE foi usado na solicitação de concessão de código de autorização. Para obter mais informações, consulte o RFC do PKCE: https://tools.ietf.org/html/rfc7636
• estado – GUID exclusivo gerado pelo usuário que é armazenado em cache pelo usuário e enviado ao servidor durante a primeira etapa do fluxo. Essa cadeia de caracteres é enviada de volta pelo servidor com o código de autorização. O estado armazenado em cache do usuário é comparado com o estado recebido do servidor para atenuar o risco de ataques CSRF. Consulte https://datatracker.ietf.org/doc/html/rfc6819#section-3.6.

Solicitar objeto passado pelo usuário para recuperar um código do servidor (primeira etapa do fluxo de concessão de código de autorização)

• escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
• declarações – uma solicitação de declarações em cadeia de caracteres que será adicionada a todas as chamadas /authorize e /token
• autoridade – URL da autoridade da qual o aplicativo adquire tokens.
• correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
• redirectUri – O URI de redirecionamento em que as respostas de autenticação podem ser recebidas pelo aplicativo. Ele deve corresponder exatamente a um dos URIs de redirecionamento registrados no portal Azure.
• extraScopesToConsent – Escopos para um recurso diferente quando o usuário precisa de consentimento antecipadamente.
• responseMode – Especifica o método que deve ser usado para enviar o resultado da autenticação para seu aplicativo. Pode ser consulta, form_post ou fragmento. Se nenhum valor for passado, ele usará como padrão a consulta.
• codeChallenge – usado para proteger a concessão de código de autorização por meio da Prova de Chave para O Código Exchange (PKCE). Para obter mais informações, consulte o PKCE RCF:https://tools.ietf.org/html/rfc7636
• codeChallengeMethod – O método usado para codificar o verificador de código para o parâmetro de desafio de código. Pode ser "simples" ou "S256". Se excluído, supõe-se que o desafio de código seja texto sem formatação. Para obter mais informações, consulte o PKCE RCF: https://tools.ietf.org/html/rfc7636
• estado – um valor incluído na solicitação que também é retornado na resposta do token. Um valor exclusivo gerado aleatoriamente normalmente é usado para evitar ataques de falsificação de solicitação entre sites. O estado também é usado para codificar informações sobre o estado do usuário no aplicativo antes da solicitação de autenticação ocorrer.
• prompt – Indica o tipo de interação do usuário que é necessário. logon: forçará o usuário a inserir suas credenciais nessa solicitação, negando o logon único: garantirá que o usuário não seja apresentado a nenhum prompt interativo. se a solicitação não puder ser concluída por meio do logon único, o ponto de extremidade retornará um consentimento de erro interaction_required: disparará a caixa de diálogo de consentimento OAuth depois que o usuário entrar, solicitando ao usuário que conceda permissões ao aplicativo select_account: interromperá o logon único, fornecendo a experiência de seleção da conta listando todas as contas na sessão ou quaisquer contas lembradas ou uma opção para optar por usar uma conta diferente, crie: direcionará o usuário para a experiência de criação da conta em vez da experiência de logon
• conta – AccountInfo obtido de uma API getAccount. Será usado em determinados cenários para gerar login_hint se os parâmetros loginHint e sid não forem fornecidos.
• loginHint - Pode ser usado para preencher previamente o campo nome de usuário/endereço de email da página de entrada do usuário, se você souber o nome de usuário/endereço de email com antecedência. Geralmente, os aplicativos usam esse parâmetro durante a autenticação nova, já tendo extraído o nome de usuário de uma entrada anterior usando a declaração preferred_username.
• sid – ID da sessão, identificador exclusivo para a sessão. Disponível como uma declaração opcional em tokens de ID.
• domainHint – Fornece uma dica sobre o locatário ou domínio que o usuário deve usar para entrar. O valor da dica de domínio é um domínio registrado para o locatário.
• extraQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /authorize
• tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
• nonce - Um valor incluído na solicitação que é retornada no token de id. Um valor exclusivo gerado aleatoriamente normalmente é usado para atenuar ataques de reprodução.

Propriedades de resposta que podem ser retornadas pelo ponto de extremidade /authorize

Opções específicas do AzureCloudInstance

• azureCloudInstance – enumeração de cadeia de caracteres que fornece notação curta para autoridades de nuvem pública e soverign
• locatário – provisionar para fornecer as informações do locatário

Use isso para configurar as opções de agente abaixo:

• nativeBrokerPlugin – Implementação de agente nativo (deve ser importada de msal-node-extensions)

Observação: essas opções só estão disponíveis para PublicClientApplications usando o fluxo de código de autorização

Repositório de valores de chave para cache na memória

Use isso para configurar as opções de configuração de cache abaixo:

• cachePlugin – Plug-in para leitura e gravação de cache de token em disco.

CommonClientCredentialRequest

• escopos – matriz de escopos aos que o aplicativo está solicitando acesso. Normalmente, contém apenas o escopo .default para um único recurso. Confira: https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc#the-default-scope
• autoridade – URL da autoridade, o STS (serviço de token de segurança) do qual a MSAL adquirirá tokens.
• correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
• skipCache – Ignorar a pesquisa de cache de token e forçar a solicitação à autoridade para obter um novo token. O padrão é false.
• clientAssertion - Uma cadeia de caracteres de asserção ou uma função de retorno de chamada que retorna uma cadeia de caracteres de asserção (ambos são JWTs assinados codificados em Base64Url) usados no fluxo de Credenciais do Cliente
• tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token

Use o objeto de configuração para configurar a MSAL e inicializar o objeto de aplicativo cliente

• auth: é aqui que você configura elementos de autenticação como clientID, autoridade usada para autenticação no Microsoft Identity Platform
• broker: é aqui que você configura as opções do agente
• cache: é aqui que você configura o local do cache
• sistema: é aqui que você pode configurar o cliente de rede, agente
• telemetria: é aqui que você pode configurar opções de telemetria

Parâmetros para o fluxo de código do dispositivo Oauth2.

• escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
• autoridade: - URL da autoridade, o STS (serviço de token de segurança) do qual a MSAL adquirirá tokens. Se a autoridade for definida no objeto de aplicativo cliente, isso substituirá esse valor. Substituir o valor fará com que a validação da autoridade ocorra sempre. Se a mesma autoridade for usada para todas as solicitações, defina no objeto do aplicativo em vez das solicitações.
• correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
• deviceCodeCallback – Retorno de chamada que contém a resposta do código do dispositivo. A mensagem deve ser mostrada ao usuário final. Em seguida, o usuário final pode navegar até o verification_uri, inserir o user_code e as credenciais de entrada.
• cancelar – booliano para cancelar a sondagem do ponto de extremidade de código do dispositivo. Enquanto o usuário se autentica em um dispositivo separado, a MSAL sonda o ponto de extremidade de token do serviço de token de segurança para o intervalo especificado na resposta de código do dispositivo (geralmente 15 minutos). Para interromper a sondagem e cancelar a solicitação, defina cancel=true.
• extraQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à cadeia de caracteres de consulta

Tipo que descreve declarações de Token de Id conhecidas pela MSAL.

Tipo intermitente para lidar com objetos de dados na memória com tipos definidos

Solicitar objeto passado pelo usuário para configurar a API acquireTokenInteractive

• openBrowser – Função para abrir uma instância do navegador no sistema do usuário.
• escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
• successTemplate: – Modelo a ser exibido na instância do navegador aberta após a aquisição bem-sucedida do token.
• errorTemplate – Modelo a ser exibido na instância do navegador aberta após falha de aquisição de token.
• windowHandle – Usado em fluxos de agente nativos para parentar corretamente a janela do agente nativo
• loopbackClient – Implementação personalizada para um servidor de loopback escutar a resposta do código de autorização.

Formato de cache lido do blob de cache fornecido para a configuração durante a instanciação do aplicativo

ManagedIdentityRequest

• declarações - uma solicitação de declarações em cadeia de caracteres que será usada para determinar se o cache deve ou não ser ignorado
• forceRefresh – força as solicitações de identidade gerenciada a ignorar o cache e fazer chamadas de rede se verdadeiras
• recurso – recurso solicitado para acessar a API protegida. Ele deve ser do formato "ResourceIdUri" ou "ResourceIdUri/.default". Por exemplo https://management.azure.net ou, para Microsoft Graph,https://graph.microsoft.com/.default

Opções permitidas por APIs de solicitação de rede.

• clientId – ID do cliente do aplicativo.
• autoridade - URL da autoridade. Se nenhum valor for definido, o padrão https://login.microsoftonline.com/commonserá .
• knownAuthorities – Necessário para Azure B2C e ADFS. Todas as autoridades que serão usadas no aplicativo cliente. Somente o host da autoridade deve ser passado.
• clientSecret – Cadeia de caracteres secreta que o aplicativo usa ao solicitar um token. Usado somente em aplicativos cliente confidenciais. Pode ser criado no portal de registro do aplicativo Azure.
• clientAssertion – um objeto ClientAssertion que contém uma cadeia de caracteres de asserção ou uma função de retorno de chamada que retorna uma cadeia de caracteres de declaração que o aplicativo usa ao solicitar um token, bem como o tipo da declaração (urn:ietf:params:oauth:client-assertion-type:jwt-bearer). Usado somente em aplicativos cliente confidenciais.
• clientCertificate – Certificado que o aplicativo usa ao solicitar um token. Usado somente em aplicativos cliente confidenciais. Requer a impressão digital X.509 SHA-1 ou SHA-256 codificada em hex do certificado e a chave privada codificada em PEM (a cadeia de caracteres deve conter -----BEGIN PRIVATE KEY----- ... -----END PRIVATE KEY----- )
• protocolMode - Enum que representa o protocolo que msal segue. Usado para configurar pontos de extremidade adequados.
• skipAuthorityMetadataCache - Um sinalizador para escolher se deseja usar ou não o cache de metadados local durante a inicialização da autoridade. O padrão é false.
• encodeExtraQueryParams – um sinalizador para escolher se deseja codificar parâmetros de consulta extras na URL da solicitação. O padrão é false.

Tipo para configurar opções de cliente http e agente

• agente – usado para inicializar o objeto Logger; TODO: Expanda os detalhes do agente ou link para a documentação no agente
• networkClient – Cliente Http usado para todas as chamadas de obtenção e postagem http. O padrão é usar o cliente http padrão da MSAL.

• escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
• autoridade – URL da autoridade, o STS (serviço de token de segurança) do qual a MSAL adquirirá tokens.
• correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
• oboAssertion – O token de acesso que foi enviado para a API de camada intermediária. Esse token deve ter um público-alvo do aplicativo que está fazendo essa solicitação OBO.
• skipCache – Ignorar a pesquisa de cache de token e forçar a solicitação à autoridade para obter um novo token. O padrão é false.
• tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token

CommonRefreshTokenRequest

• escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
• declarações – uma solicitação de declarações em cadeia de caracteres que será adicionada a todas as chamadas /authorize e /token
• autoridade – URL da autoridade, o STS (serviço de token de segurança) do qual a MSAL adquirirá tokens.
• correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
• refreshToken – um token de atualização retornado de uma solicitação anterior para o provedor de identidade.
• tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
• forceCache – Force a MSAL a armazenar em cache uma resposta de fluxo de token de atualização quando não houver nenhuma conta no cache. Usado para cenários de migração.

Tipo de credencial de token de acesso

Tipo de conta

Tipo appMetadata

Tipo de credencial Idtoken

Atualizar tipo de credencial de token

Parâmetros do SilentFlow passados pelo usuário para recuperar credenciais silenciosamente

• escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
• declarações – uma solicitação de declarações em cadeia de caracteres que será adicionada a todas as chamadas /authorize e /token. Quando incluído em uma solicitação silenciosa, a pesquisa de cache será ignorada e o token será atualizado.
• autoridade – URL da autoridade da qual o aplicativo adquire tokens.
• correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
• tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token
• conta – Entidade de conta para pesquisar as credenciais.
• forceRefresh – Força solicitações silenciosas para fazer chamadas de rede se verdadeiras.

Parâmetros usernamePassword passados pelo usuário para recuperar credenciais Observação: a prática atual de segurança mais recente do OAuth 2.0 não permite totalmente a concessão de senha. Esse fluxo é adicionado para testes internos.

• escopos – matriz de escopos aos que o aplicativo está solicitando acesso.
• declarações – uma solicitação de declarações em cadeia de caracteres que será adicionada a todas as chamadas /authorize e /token. Quando incluído em uma solicitação silenciosa, a pesquisa de cache será ignorada e o token será atualizado.
• autoridade – URL da autoridade da qual o aplicativo adquire tokens.
• correlationId – conjunto guid exclusivo por solicitação para rastrear uma solicitação de ponta a ponta para fins de telemetria.
• nome de usuário – nome de usuário do cliente
• senha - credenciais
• tokenQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à chamada /token

Nível de mensagem de log.

Nomes de origem de identidade gerenciada

Modos de protocolo compatíveis com a MSAL.

valores permitidos para response_mode

Classe AuthErrorMessage que contém constantes de cadeia de caracteres usadas por códigos de erro e mensagens.

Constantes de cadeia de caracteres usadas por códigos de erro e mensagens.

Classe ClientConfigurationErrorMessage que contém constantes de cadeia de caracteres usadas por códigos de erro e mensagens.

Erros de interação necessários definidos pelo SDK

consideramos fazer essa "enumeração" na solicitação em vez de cadeia de caracteres, no entanto, parece que a lista permitida de valores de prompt continuou mudando nos últimos dois anos. Há alguns valores de prompt não documentados para alguns parceiros internos também, daí a escolha do tipo genérico de "cadeia de caracteres" em vez de "enumerar"