Tipo de recurso phoneAuthenticationMethodphoneAuthenticationMethod resource type

Namespace: microsoft.graphNamespace: microsoft.graph

Importante

As APIs sob /beta a versão do Microsoft Graph estão sujeitas a alterações.APIs under the /beta version in Microsoft Graph are subject to change. Não há suporte para o uso dessas APIs em aplicativos de produção.Use of these APIs in production applications is not supported. Para determinar se uma API está disponível na versão 1.0, use o seletor de versão.To determine whether an API is available in v1.0, use the Version selector.

Uma representação de um telefone registrado para um usuário.A representation of a phone registered to a user. 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.This resource includes the phone number, the phone type, and whether the phone is configured for the user to sign in via SMS.

Um telefone tem um dos três tipos: celular, celular alternativo ou office.A phone has one of three types: mobile, alternate mobile, or 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.A user can have one number registered for each type, and must have a mobile phone before an alternate mobile phone is added. 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.When using a phone for multi-factor authentication (MFA) or self-service password reset (SSPR), the mobile phone is the default and the alternate mobile phone is the backup.

Os telefones celulares podem ser usados para sms e chamadas de voz, dependendo das configurações do locatário.Mobile phones can be used for both SMS and voice calls, depending on the tenant settings.

Um telefone do office só pode receber chamadas de voz, não mensagens SMS.An office phone can only receive voice calls, not SMS messages.

MétodosMethods

MétodoMethod Tipo de retornoReturn Type DescriçãoDescription
ListList phoneAuthenticationMethodphoneAuthenticationMethod Leia propriedades e relações de todos os objetos phoneAuthenticationMethod deste usuário.Read properties and relationships of all of this user's phoneAuthenticationMethod objects.
GetGet phoneAuthenticationMethodphoneAuthenticationMethod Ler propriedades e relações do objeto phoneAuthenticationMethod.Read properties and relationships of phoneAuthenticationMethod object.
AtualizaçãoUpdate phoneAuthenticationMethodphoneAuthenticationMethod Atualizar o objeto phoneAuthenticationMethod.Update phoneAuthenticationMethod object.
DeleteDelete NenhumNone Excluir objeto phoneAuthenticationMethod.Delete phoneAuthenticationMethod object.
Desabilitar a assinatura de SMSDisable SMS signin NenhumNone Desativar a assinatura SMS para um usuário.Turn off SMS sign-in for a user.
Habilitar a assinatura de SMSEnable SMS signin NenhumNone Ativar a assinatura SMS para um usuário.Turn on SMS sign-in for a user.

PropriedadesProperties

PropriedadeProperty TipoType DescriçãoDescription
idid Cadeia de caracteresString O identificador desse telefone registrado para esse usuário.The identifier of this phone registered to this user. Somente leitura.Read-only.

O valor da id é um dos seguintes:The value of id is one of the following:
  • b6332ec1-7057-4abe-9331-3d72feddfe41 - onde phoneType é alternateMobile .b6332ec1-7057-4abe-9331-3d72feddfe41 - where phoneType is alternateMobile.
  • e37fc753-ff3b-4958-9484-eaa9425c82bc - onde phoneType é office .e37fc753-ff3b-4958-9484-eaa9425c82bc - where phoneType is office.
  • 3179e48a-750b-4051-897c-87b9720928f7 - onde phoneType é mobile .3179e48a-750b-4051-897c-87b9720928f7 - where phoneType is mobile.
phoneNumberphoneNumber StringString O número de telefone para texto ou chamada para autenticação.The phone number to text or call for authentication. Os números de telefone usam o formato "+ <country code> <number> <extension> x", com a extensão opcional.Phone numbers use the format "+<country code> <number>x<extension>", with extension optional. Por exemplo, +1 5555551234 ou +1 5555551234x123 são válidos.For example, +1 5555551234 or +1 5555551234x123 are valid. Os números são rejeitados ao criar/atualizar se não corresponderem ao formato necessário.Numbers are rejected when creating/updating if they do not match the required format.
phoneTypephoneType authenticationPhoneTypeauthenticationPhoneType O tipo deste telefone.The type of this phone. Os valores possíveis são: mobile, alternateMobile ou office.Possible values are: mobile, alternateMobile, or office.
smsSignInStatesmsSignInState authenticationMethodSignInStateauthenticationMethodSignInState Se um telefone está pronto para ser usado para entrar no SMS ou não.Whether a phone is ready to be used for SMS sign-in or not. Os valores possíveis são: notSupported , , , , , ou , notAllowedByPolicy notEnabled phoneNumberNotUnique ready notConfigured unknownFutureValue .Possible values are: notSupported, notAllowedByPolicy, notEnabled, phoneNumberNotUnique, ready, or notConfigured, unknownFutureValue.

valores smsSignInStatesmsSignInState values

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.The SMS sign-in state property gives information about whether or not a phone number is ready to sign in via SMS. A seguir estão os valores possíveis.The following are the possible values.

ValorValue DescriçãoDescription
notSupportednotSupported 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.Primary sign-in not supported on this authentication method - for example, sign-in can be enabled only on a user's primary mobile number, not the alternate number.
notAllowedByPolicynotAllowedByPolicy Esse usuário não está habilitado pela política para usar esse método como uma assinatura primária.This user isn't enabled by policy to use this method as a primary sign-in.
notConfigurednotConfigured Esse usuário está habilitado pela política para usar esse método como login principal, mas precisa tomar medidas adicionais para configurá-lo.This user is enabled by policy to use this method as primary sign-in but needs to take additional action to configure it.
phoneNumberNotUniquephoneNumberNotUnique 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.This user attempted to set up a phone number as primary sign-in but the number was not unique and can't be used as a sign-in name.
readyready Esse método de autenticação está pronto para ser usado na login principal.This authentication method is ready for use in primary sign-in.
notEnablednotEnabled Esse método de login não está habilitadoThis sign-in method is not enabled

RelaçõesRelationships

NenhumNone.

Representação JSONJSON representation

Veja a seguir uma representação JSON do recurso.The following is a JSON representation of the resource.

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