CommonDeviceCodeRequest type

Pacote:
@azure/msal-common

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

  • scopes - Array de escopos aos quais a aplicação está a pedir acesso.
  • autoridade: - URL da autoridade, o serviço de token de segurança (STS) do qual a MSAL irá adquirir tokens. Se a authority for definida no objeto da aplicação cliente, esta irá sobrepor esse valor. Sobrepor o valor fará com que a validação da autoridade aconteça cada vez. Se a mesma autoridade for usada para todos os pedidos, defina o objeto de aplicação em vez dos pedidos.
  • correlationId - GUID único definido por pedido para rastrear um pedido de ponta a ponta para fins de telemetria.
  • deviceCodeCallback - Chamada de retorno contendo resposta ao código do dispositivo. A mensagem deve ser mostrada ao utilizador final. O utilizador final pode então navegar até à verification_uri, introduzir a user_code e introduzir credenciais.
  • cancel - Booleano para cancelar o sondamento do endpoint do código do dispositivo. Enquanto o utilizador autentica num dispositivo separado, o MSAL consulta o endpoint do token do serviço de token de segurança para o intervalo especificado na resposta ao código do dispositivo (normalmente 15 minutos). Para parar de fazer polling e cancelar o pedido, defina cancel=true.
  • resourceRequestMethod - Tipo de pedido HTTP usado para solicitar dados ao recurso (ou seja, "GET", "POST", etc.). Usado para fluxos de prova de posse.
  • resourceRequestUri - URI para o qual o token será usado. Usado para fluxos de prova de posse.
  • timeout - Período de timeout em segundos que o utilizador configura explicitamente para a sondagem do endpoint do código do dispositivo. No final deste período; assumindo que o código do dispositivo ainda não expirou; A sondagem do código do dispositivo é interrompida e o pedido cancelado. A janela de expiração do código do dispositivo terá sempre prioridade sobre este período definido.
  • extraQueryParameters - Mapa de string para string de parâmetros personalizados de consulta adicionados à cadeia de query
type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}