Create phoneMethod

Namespace: microsoft.graph

Adicione um novo método de autenticação por telefone para um usuário. Um usuário só pode ter um telefone de cada tipo, capturado na propriedade phoneType . Isso significa, por exemplo, que a adição de um mobile telefone a um usuário com um telefone pré-existente mobile falha. Além disso, um usuário deve sempre ter um mobile telefone antes de adicionar um alternateMobile telefone.

Adicionar um número de telefone o torna disponível para uso na MFA (autenticação multifator) do Azure e na SSPR (redefinição de senha de autoatendimento), se habilitado.

Além disso, se um usuário for habilitado pela política para usar a entrada por SMS e um mobile número for adicionado, o sistema tentará registrar o número para uso nesse sistema.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) UserAuthMethod-Phone.ReadWrite UserAuthMethod-Phone.ReadWrite.All, UserAuthenticationMethod.ReadWrite, UserAuthenticationMethod.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application UserAuthenticationMethod.ReadWrite.All UserAuthMethod-Phone.ReadWrite.All

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. Esta operação dá suporte às seguintes funções internas, que fornecem apenas o menor privilégio necessário:

  • Administrador de Autenticação
  • Administrador de Autenticação Privilegiada

Quando os usuários gerenciam seus próprios métodos de autenticação, o sistema solicita que eles concluam a autenticação multifator (MFA) se eles foram autenticados pela última vez há mais de 10 minutos na sessão atual.

Solicitação HTTP

Adicione um método de autenticação por telefone à conta de outro usuário. Os usuários não podem adicionar um método de autenticação por telefone à própria conta.

POST /users/{id | userPrincipalName}/authentication/phoneMethods

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON de um objeto phoneAuthenticationMethod . O JSON deve incluir phoneNumber e phoneType, mas não smsSignInState (que é somente leitura).

Propriedade Tipo Descrição
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 +{country code} {number}x{extension}, com extensão opcional. Por exemplo, +1 5555551234 ou +1 5555551234x123 são válidos. Os números serão rejeitados na criação ou atualização se não corresponderem ao formato necessário.
phoneType Cadeia de caracteres Os valores possíveis são mobile, alternateMobile e office.

Resposta

Se for bem-sucedido, esse método retornará um código de 201 Created resposta e um novo objeto phoneAuthenticationMethod no corpo da resposta.

Exemplos

Solicitação

Veja um exemplo da solicitação.

POST https://graph.microsoft.com/v1.0/users/kim@contoso.com/authentication/phoneMethods
Content-type: application/json

{
  "phoneNumber": "+1 2065555555",
  "phoneType": "mobile"
}

Resposta

Veja um exemplo de resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-type: application/json

{
  "phoneNumber": "+1 2065555555",
  "phoneType": "phoneType-value",
  "smsSignInState": "ready",
  "id": "3179e48a-750b-4051-897c-87b9720928f7"
}