Criar 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.
Adicione um novo método de autenticação telefônica. Um usuário pode ter apenas um telefone de cada tipo, capturado na propriedade phoneType . Isso significa que, por exemplo, a adição de um mobile
telefone a um usuário com um telefone preexistência mobile
falhará. Além disso, um usuário deve sempre ter um mobile
telefone antes de adicionar um alternateMobile
telefone.
A adição de um número de telefone o disponibiliza para uso tanto na MFA (autenticação multifator do Azure) quanto na SSPR (redefinição de senha de autoatendimento), se habilitada.
Além disso, se um usuário estiver habilitado pela política para usar a entrada 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 nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas |
---|---|---|
Delegado (conta corporativa ou de estudante) | UserAuthenticationMethod.ReadWrite.All | UserAuthenticationMethod.ReadWrite |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Aplicativo | UserAuthenticationMethod.ReadWrite.All | Indisponível. |
Para cenários delegados, o administrador precisa, pelo menos, da função Administrador de Autenticação ou Administrador de Autenticação PrivilegiadaMicrosoft Entra.
Os usuários não podem adicionar um método de autenticação telefônica à sua própria conta.
Solicitação HTTP
Adicione um método de autenticação telefônica à conta de outro usuário.
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 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 555551234x123 são válidos. Os números são rejeitados ao criar/atualizar 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 201 Created
código de resposta e um novo objeto phoneAuthenticationMethod no corpo da resposta.
Exemplos
Solicitação
O exemplo a seguir mostra uma solicitação.
POST https://graph.microsoft.com/beta/users/kim@contoso.com/authentication/phoneMethods
Content-type: application/json
{
"phoneNumber": "+1 2065555555",
"phoneType": "mobile"
}
Resposta
O exemplo a seguir mostra a 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"
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de