tipo de recurso phoneAuthenticationMethod

  • Artigo

Namespace: microsoft.graph

Representa um número de telefone e um tipo registrados para um usuário e se ele está configurado para que o usuário entre por SMS.

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

Os telefones celulares primários podem ser usados para chamadas por SMS e voz, dependendo das configurações do locatário.

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

Esse é um tipo derivado que herda do tipo de recurso authenticationMethod .

Métodos

Método Tipo de retorno Descrição
Listar phoneMethods phoneAuthenticationMethod Leia propriedades e relações de todos os objetos phoneAuthenticationMethod desse usuário.
Obter phoneAuthenticationMethod phoneAuthenticationMethod Leia propriedades e relações do objeto phoneAuthenticationMethod para um usuário.
Criar phoneMethod phoneAuthenticationMethod Crie um objeto phoneAuthenticationMethod de um usuário.
Atualizar phoneAuthenticationMethod Nenhum Atualize o objeto phoneAuthenticationMethod para um usuário.
Excluir phoneAuthenticationMethod Nenhum Exclua o objeto phoneAuthenticationMethod para um usuário.
Desabilitar a entrada sms Nenhum Desative a entrada de SMS para um usuário.
Habilitar a entrada do SMS Nenhum Ative a entrada de SMS para um usuário.

Propriedades

Propriedade Tipo Descrição
id Cadeia de caracteres O identificador deste telefone registrado para este usuário. Somente 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 Cadeia de caracteres O número de telefone para enviar texto ou chamar para autenticação. Os números de telefone usam o formato +{country code} {number}x{extension}, com a extensão opcional. Por exemplo, +1 5555551234 ou +1 5555551234x123 são válidos. Os números são rejeitados ao criar ou atualizar se não corresponderem ao formato necessário.
phoneType authenticationPhoneType O tipo desse telefone. Os valores possíveis são: mobile, alternateMobile ou office.
smsSignInState authenticationMethodSignInState Se um telefone está pronto para ser usado para entrada por SMS ou não. Os valores possíveis são: notSupported, , notAllowedByPolicy, phoneNumberNotUniquenotEnabled, , readyou notConfigured, unknownFutureValue.

valores authenticationPhoneType

Os telefones podem ser de três tipos, os seguintes são os valores possíveis.

Valor Descrição
móvel Um telefone celular primário, utilizável para SMS e chamadas de voz.
alternateMobile Um telefone celular alternativo ou de backup, utilizável apenas para chamadas de voz.
office Um telefone do office ou telefone fixo, utilizável apenas para chamadas de voz.

valores authenticationMethodSignInState

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

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

Relações

Nenhum

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

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