CommonDeviceCodeRequest type

Pacote:
@azure/msal-common

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.
  • resourceRequestMethod – Tipo de solicitação HTTP usado para solicitar dados do 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.
  • tempo limite – período de tempo limite em segundos que o usuário configura explicitamente para a sondagem do ponto de extremidade de código do dispositivo. No final desse período; supondo que o código do dispositivo ainda não expirou; a sondagem do código do dispositivo é interrompida e a solicitação cancelada. A janela de expiração do código do dispositivo sempre terá precedência durante esse período de conjunto.
  • extraQueryParameters – Cadeia de caracteres para o mapa de cadeia de caracteres de parâmetros de consulta personalizados adicionados à cadeia de caracteres de consulta
type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}