authenticationMethod: resetPassword

Namespace: microsoft.graph

Redefinir a senha de um usuário, representada por um objeto de método de autenticação de senha . Isso só pode ser feito por um administrador com as permissões apropriadas e não pode ser feito na própria conta de um usuário.

Para redefinir a senha de um usuário no Azure AD B2C, use a operação Update user API e atualize o objeto passwordProfile>forceChangePasswordNextSignIn.

Esse fluxo grava a nova senha no Microsoft Entra ID e a envia por push para o Active Directory local, se configurado usando write-back de senha. O administrador pode fornecer uma nova senha ou fazer com que o sistema gere uma. O usuário é solicitado a alterar a senha no próximo login.

Essa redefinição é uma operação de execução longa e retorna um cabeçalho Location com um link no qual o chamador pode marcar periodicamente o status da operação de redefinição.

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) UserAuthenticationMethod.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Sem suporte. Sem suporte.

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.

Os administradores com funções de Administrador de Usuários, Administrador de Assistência Técnica ou Administrador de Senhas também podem redefinir senhas para usuários não administradores e um conjunto limitado de funções de administrador, conforme definido em Quem pode redefinir senhas.

Solicitação HTTP

A ID do método de autenticação de senha, referenciada por {passwordMethods-id}, é sempre 28c10230-6103-485e-b985-444c60001490.

POST /users/{id | userPrincipalName}/authentication/methods/{passwordMethods-id}/resetPassword

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

Forneça um objeto JSON com os seguintes parâmetros no corpo da solicitação.

Parâmetro Tipo Descrição
newPassword Cadeia de caracteres A nova senha. Necessário para locatários com cenários de senha híbrida. Se omitido para uma senha somente na nuvem, o sistema retornará uma senha gerada pelo sistema. Esta é uma cadeia de caracteres unicode sem outra codificação. Ele é validado em relação ao sistema de senhas proibidas do locatário antes da aceitação e deve aderir aos requisitos de senha local e/ou de nuvem do locatário.

Resposta

Se o chamador forneceu uma senha no corpo da solicitação, esse método retornará um código de 202 Accepted resposta e nenhum corpo de resposta. A resposta também pode incluir um cabeçalho Location com uma URL para marcar o status da operação de redefinição.

Se o chamador usou a opção de senha gerada pelo sistema, esse método retornará um 202 Accepted código de resposta e um objeto passwordResetResponse no corpo da resposta que contém uma senha gerada pela Microsoft. A resposta também pode incluir um cabeçalho Location com uma URL para marcar o status da operação de redefinição.

Cabeçalhos de resposta

Nome Descrição
Local URL a ser chamada para marcar o status da operação. Obrigatório.
Tentar novamente Duração em segundos. Opcional.

Exemplos

Exemplo 1: senha enviada pelo usuário

O exemplo a seguir mostra como chamar essa API quando o chamador envia uma senha.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/methods/28c10230-6103-485e-b985-444c60001490/resetPassword
Content-type: application/json

{
    "newPassword": "Cuyo5459"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 202 Accepted
Content-type: application/json
Location: https://graph.microsoft.com/v1.0/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/operations/88e7560c-9ebf-435c-8089-c3998ac1ec51?aadgdc=DUB02P&aadgsu=ssprprod-a

Exemplo 2: senha gerada pelo sistema

O exemplo a seguir mostra como chamar essa API quando o chamador não envia uma senha.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/methods/28c10230-6103-485e-b985-444c60001490/resetPassword

{

}

Resposta

O exemplo a seguir mostra a resposta. Você pode usar a ID no cabeçalho Location para marcar o status da operação por meio da API de operação de longa execução.

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

HTTP/1.1 202 Accepted
Location: https://graph.microsoft.com/v1.0/users/6ea91a8d-e32e-41a1-b7bd-d2d185eed0e0/authentication/operations/77bafe36-3ac0-4f89-96e4-a4a5a48da851?aadgdc=DUB02P&aadgsu=ssprprod-a
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#microsoft.graph.passwordResetResponse",
    "newPassword": "Cuyo5459"
}