Atualizar 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.
Atualize o número de telefone associado a um método de autenticação de telefone.
Não pode alterar o tipo de telefone. Para alterar o tipo de um telemóvel, adicione um novo número do tipo pretendido e, em seguida, elimine o objeto com o tipo original.
Se um utilizador estiver ativado pela política para utilizar SMS para iniciar sessão e o mobile
número for alterado, o sistema tenta registar o número para utilização nesse sistema.
As operações self-service não são suportadas.
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 em que o utilizador com sessão iniciada está a agir sobre outro utilizador, tem de lhes ser atribuída 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 atualizar o seu próprio método de autenticação de telemóvel.
Solicitação HTTP
Atualize o método de autenticação do telemóvel de outro utilizador.
PATCH /users/{id | userPrincipalName}/authentication/phoneMethods/{phoneMethodId}
O valor correspondente phoneMethodId
ao phoneType a atualizar é um dos seguintes:
-
b6332ec1-7057-4abe-9331-3d72feddfe41
para atualizar oalternateMobile
phoneType. -
e37fc753-ff3b-4958-9484-eaa9425c82bc
para atualizar ooffice
phoneType. -
3179e48a-750b-4051-897c-87b9720928f7
para atualizar omobile
phoneType.
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 os valores para os campos relevantes que devem ser atualizados. As propriedades existentes que não estão incluídas no corpo do pedido serão recalculadas com base em alterações a outros valores de propriedade.
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 | string | Os valores possíveis são: mobile , alternateMobile ou office . |
Resposta
Se for bem-sucedido, este método devolve um 200 OK
código de resposta e um objeto phoneAuthenticationMethod atualizado no corpo da resposta.
Exemplos
Solicitação
O exemplo a seguir mostra uma solicitação.
PATCH https://graph.microsoft.com/beta/users/kim@contoso.com/authentication/phoneMethods/3179e48a-750b-4051-897c-87b9720928f7
Content-type: application/json
{
"phoneNumber": "+1 2065555554",
"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 200 OK
Content-type: application/json
{
"phoneNumber": "+1 2065555554",
"phoneType": "mobile",
"smsSignInState": "ready",
"id": "3179e48a-750b-4051-897c-87b9720928f7"
}