Tipo de recurso phoneAuthenticationMethod

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.

Uma representação de um telefone registrado para um usuário. Esse recurso inclui o número de telefone, o tipo de telefone e se o telefone está configurado para o usuário entrar via SMS.

Um telefone tem um dos três tipos: celular, celular alternativo ou office. Um usuário pode ter um número registrado para cada tipo e deve ter um telefone celular antes que um telefone celular alternativo seja adicionado. Ao usar um telefone para autenticação multifafação (MFA) ou redefinição de senha de autoatendência (SSPR), o telefone celular é o padrão e o telefone celular alternativo é o backup.

Os telefones celulares podem ser usados para sms e chamadas de voz, dependendo das configurações do locatário.

Um telefone do office só pode receber chamadas de voz, não mensagens SMS.

Methods

Método Tipo de retorno Descrição
List phoneAuthenticationMethod Leia propriedades e relações de todos os objetos phoneAuthenticationMethod deste usuário.
Get phoneAuthenticationMethod Ler propriedades e relações do objeto phoneAuthenticationMethod.
Atualizar phoneAuthenticationMethod Atualizar o objeto phoneAuthenticationMethod.
Excluir Nenhum Excluir objeto phoneAuthenticationMethod.
Desabilitar a assinatura de SMS Nenhum Desativar a assinatura SMS para um usuário.
Habilitar a assinatura de SMS Nenhum Ativar a assinatura SMS para um usuário.

Propriedades

Propriedade Tipo Descrição
id String O identificador desse telefone registrado para esse usuário. Apenas leitura.

O valor da id é um dos seguintes:
  • b6332ec1-7057-4abe-9331-3d72feddfe41 - onde phoneType é alternateMobile .
  • e37fc753-ff3b-4958-9484-eaa9425c82bc - onde phoneType é office .
  • 3179e48a-750b-4051-897c-87b9720928f7 - onde phoneType é mobile .
phoneNumber String O número de telefone para texto ou chamada para autenticação. Telefone números usam o formato "+ <country code> <number> x <extension> ", com extensão opcional. Por exemplo, +1 5555551234 ou +1 5555551234x123 são válidos. Os números são rejeitados ao criar/atualizar se não corresponderem ao formato necessário.
phoneType authenticationPhoneType O tipo deste telefone. Os valores possíveis são: mobile, alternateMobile ou office.
smsSignInState authenticationMethodSignInState Se um telefone está pronto para ser usado para entrar no SMS ou não. Os valores possíveis são: notSupported , , , , , ou , notAllowedByPolicy notEnabled phoneNumberNotUnique ready notConfigured unknownFutureValue .

valores smsSignInState

A propriedade de estado de login SMS fornece informações sobre se um número de telefone está ou não pronto para entrar via SMS. A seguir estão os valores possíveis.

Valor Descrição
notSupported Não há suporte para entrar primário nesse método de autenticação, por exemplo, a login só pode ser habilitada no número móvel principal de um usuário, não no número alternativo.
notAllowedByPolicy Esse usuário não está habilitado pela política para usar esse método como uma assinatura primária.
notConfigured Esse usuário está habilitado pela política para usar esse método como login principal, mas precisa tomar medidas adicionais para configurá-lo.
phoneNumberNotUnique Esse usuário tentou configurar um número de telefone como login principal, mas o número não era exclusivo e não pode ser usado como um nome de login.
ready Esse método de autenticação está pronto para ser usado na login principal.
notEnabled Esse método de login não está habilitado

Relações

Nenhum

Representação JSON

Veja a seguir uma representação JSON do recurso.

{
  "id": "String (identifier)",
  "phoneNumber": "String",
  "phoneType": "string",
  "smsSignInState": "string"
}