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 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 por SMS.

Um telefone tem um dos três tipos: celular, celular alternativo ou escritório. 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 MFA (autenticação multifator) ou SSPR (redefinição de senha de autoatendimento), o celular é o padrão e o celular alternativo é o backup.

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

Um telefone comercial 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
List phoneAuthenticationMethod Leia as propriedades e as relações de todos os objetos phoneAuthenticationMethod desse usuário.
Get phoneAuthenticationMethod Leia as propriedades e as relações do objeto phoneAuthenticationMethod.
Add phoneAuthenticationMethod Crie o objeto phoneAuthenticationMethod do usuário.
Atualizar phoneAuthenticationMethod Atualize o objeto phoneAuthenticationMethod.
Delete Nenhum Exclua o objeto phoneAuthenticationMethod.
Desabilitar entrada por SMS Nenhum Desative a entrada por SMS para um usuário.
Habilitar entrada por SMS Nenhum Ative a entrada por SMS para um usuário.

Propriedades

Propriedade Tipo Descrição
createdDateTime DateTimeOffset A data e hora em que o método de autenticação foi registrado para o usuário. Somente leitura. Opcional. O tipo de carimbo de data/hora representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
lastUsedDateTime DateTimeOffset A data e a hora em que o método de autenticação foi usado pelo usuário pela última vez. Somente leitura. Opcional. Esse valor opcional é null se o método de autenticação não o preencher. O tipo de carimbo de data/hora representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Herdado de authenticationMethod.
id Cadeia de caracteres O identificador deste telefone registrado para este usuário. Somente leitura.

O valor de ID é um dos seguintes:
  • b6332ec1-7057-4abe-9331-3d72feddfe41 - where phoneType is alternateMobile.
  • e37fc753-ff3b-4958-9484-eaa9425c82bc - where phoneType is office.
  • 3179e48a-750b-4051-897c-87b9720928f7 - where phoneType is mobile.
phoneNumber Cadeia de caracteres O número de telefone para enviar uma mensagem de texto ou ligar para autenticação. Os números de telefone usam o formato "+<número do código>><do país x<extensão>", com extensão opcional. Por exemplo, +1 5555551234 ou +1 5555551234x123 são válidos. Os números serã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 entrada por SMS ou não. Os valores possíveis são: notSupported, notAllowedByPolicy, notEnabledphoneNumberNotUnique, ready, ou notConfigured, unknownFutureValue.

valores authenticationPhoneType

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

Valor Descrição
móvel Um telefone celular principal, utilizável para SMS e chamadas de voz.
alternateMobile Um telefone celular alternativo ou de backup, utilizável somente para chamadas de voz.
office Um telefone fixo ou telefone comercial, utilizável somente para chamadas de voz.

valores authenticationMethodSignInState

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

Valor Descrição
notSupported A entrada principal não é compatível com esse método de autenticação - por exemplo, a entrada pode ser habilitada somente no número de celular principal do 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 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 Este usuário tentou configurar um número de telefone como entrada principal, 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 no logon principal.
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.

{
  "@odata.type": "#microsoft.graph.phoneAuthenticationMethod",
  "createdDateTime": "String (timestamp)",
  "lastUsedDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "phoneNumber": "String",
  "phoneType": "string",
  "smsSignInState": "string"
}