Início de sessão no MSAL para Android

As aplicações Biblioteca de Autenticação da Microsoft (MSAL) geram mensagens de registo que podem ajudar a diagnosticar problemas. Uma aplicação pode configurar registos com algumas linhas de código e ter controlo personalizado sobre o nível de detalhe e se os dados pessoais e organizacionais são registados ou não. Recomendamos que crie uma implementação de registo MSAL e forneça uma forma para os utilizadores submeterem registos quando tiverem problemas de autenticação.

Níveis de registo

O MSAL fornece vários níveis de detalhe de registo:

  • LogAlways: Não é feita filtragem de nível neste nível de log. As mensagens de registo de todos os níveis serão registadas.
  • Crítico: Registos que descrevem uma falha de aplicação ou sistema irrecuperável, ou uma falha catastrófica que requer atenção imediata.
  • Erro: Indica que algo correu mal e foi gerado um erro. Usado para depuração e identificação de problemas.
  • Aviso: Não houve necessariamente um erro ou falha, mas destinam-se a diagnósticos e à identificação de problemas.
  • Informativo: O MSAL regista eventos para fins informativos, não necessariamente para depuração.
  • Verbose (Predefinição): o MSAL regista todos os detalhes do comportamento da biblioteca.

Note

Nem todos os níveis de log estão disponíveis para todos os SDKs MSAL

Dados pessoais e organizacionais

Por predefinição, o sistema de registo do MSAL não captura dados pessoais nem organizacionais de elevada sensibilidade. A biblioteca oferece a opção de permitir o registo de dados pessoais e organizacionais, caso assim o decida.

As secções seguintes fornecem mais detalhes sobre o registo de erros MSAL para a sua aplicação.

Iniciar sessão em MSAL para Android usando Java

Ative o login na criação da aplicação criando um callback de registo. O callback assume estes parâmetros:

  • tag é uma string passada para o callback pela biblioteca. Está associado à entrada do registo e pode ser usado para ordenar mensagens de registo.
  • logLevel Permite-lhe decidir que nível de registo deseja. Os níveis logarítmicos suportados são: Error, Warning, Info, e Verbose.
  • message é o conteúdo da entrada do registo.
  • containsPII especifica se as mensagens que contêm dados pessoais ou dados organizacionais são registadas. Por defeito, isto está definido como falso, para que a sua aplicação não registre dados pessoais. Se containsPII é true, este método receberá as mensagens duas vezes: uma vez com o parâmetro containsPII definido como false e o message sem dados pessoais, e uma segunda vez com o parâmetro containsPii definido como true e a mensagem pode conter dados pessoais. Em alguns casos (quando a mensagem não contém dados pessoais), a mensagem será a mesma.
private StringBuilder mLogs;

mLogs = new StringBuilder();
Logger.getInstance().setExternalLogger(new ILoggerCallback()
{
   @Override
   public void log(String tag, Logger.LogLevel logLevel, String message, boolean containsPII)
   {
      mLogs.append(message).append('\n');
   }
});

Por defeito, o logger do MSAL não captura quaisquer informações de identificação pessoal nem informações de identificação da organização. Para permitir o registo de informações de identificação pessoal ou de informações de identificação organizacional:

Logger.getInstance().setEnablePII(true);

Para desativar o registo de dados pessoais e dados da organização:

Logger.getInstance().setEnablePII(false);

Por defeito, o login no logcat está desativado. Para ativar:

Logger.getInstance().setEnableLogcatLog(true);

Passos seguintes

Para mais exemplos de código, consulte exemplos de código da plataforma de identidades da Microsoft.