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 de telemóvel. Um utilizador pode ter apenas um telemóvel de cada tipo, capturado na propriedade phoneType . Isto significa, por exemplo, que a adição de um mobile
telemóvel a um utilizador com um telemóvel pré-existido mobile
falhará. Além disso, um utilizador tem de ter sempre um mobile
telemóvel antes de adicionar um alternateMobile
telemóvel.
Adicionar um número de telefone disponibiliza-o para utilização na autenticação multifator (MFA) do Azure e na reposição personalizada de palavra-passe (SSPR), se ativada.
Além disso, se um utilizador estiver ativado pela política para utilizar o início de sessão por SMS e for adicionado um mobile
número, o sistema tenta registar o número para utilização nesse sistema.
Esta API está disponível nas seguintes implementações de cloud nacionais.
Serviço global | US Government L4 | US Government L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.
Tipo de permissão | Permissões com menos privilégios | Permissões com privilégios superiores |
---|---|---|
Delegado (conta corporativa ou de estudante) | UserAuthenticationMethod.ReadWrite.All | Indisponível. |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Application | UserAuthenticationMethod.ReadWrite.All | Indisponível. |
Importante
Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.
- Administrador de Autenticação
- Administrador de Autenticação Privilegiada
Os utilizadores não podem adicionar um método de autenticação de telemóvel à sua própria conta.
Solicitação HTTP
Adicione um método de autenticação de telemóvel à conta de outro utilizador.
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 do pedido, forneça uma representação JSON de um objeto phoneAuthenticationMethod . O JSON tem de incluir phoneNumber
e phoneType
, mas não smsSignInState
(que é só de leitura).
Propriedade | Tipo | Descrição |
---|---|---|
phoneNumber | Cadeia de caracteres | O número de telefone para enviar sms ou ligar para autenticação. Os números de telefone utilizam 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/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, este método devolve 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"
}