Atualizar usuário

Namespace: microsoft.graph

Atualizar as propriedades de um objeto usuário. Nem todas as propriedades podem ser atualizadas por usuários Membros ou Convidados com suas permissões padrão sem Funções de administrador. Compare as permissões padrão de membros e convidados para ver as propriedades que eles podem gerenciar.

Os clientes por meio de Microsoft Entra ID para clientes também podem usar essa operação de API para atualizar seus detalhes. Consulte Permissões de usuário padrão em locatários de clientes para obter a lista de propriedades que podem ser atualizadas.

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) User.ReadWrite User.ManageIdentities.All, User.EnableDisableAccount.All, User.ReadWrite.All, Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) User.ReadWrite Indisponível.
Application User.ManageIdentities.All User.EnableDisableAccount.All, User.ReadWrite.All, Directory.ReadWrite.All

Observação

  • Para atualizar propriedades confidenciais do usuário, como accountEnabled, mobilePhone e outrosMails para usuários com funções de administrador privilegiadas:
    • Em cenários delegados, o aplicativo deve receber a permissão delegada Directory.AccessAsUser.All e o usuário de chamada deve ter uma função de administrador privilegiado maior, conforme indicado em Quem pode executar ações confidenciais.
    • Em cenários somente de aplicativo, o aplicativo deve receber uma função de administrador privilegiado maior, conforme indicado em Quem pode executar ações confidenciais.
  • Sua conta pessoal da Microsoft deve estar vinculada a um locatário Microsoft Entra para atualizar seu perfil com a permissão delegada User.ReadWrite em uma conta pessoal da Microsoft.
  • Atualizar a propriedade identidades requer a permissão User.ManageIdentities.All . Além disso, não é permitido adicionar uma conta local B2C a um objeto de usuário existente, a menos que o objeto de usuário já tenha uma identidade de conta local.

Solicitação HTTP

PATCH /users/{id | userPrincipalName}

Cabeçalhos de solicitação

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

Corpo da solicitação

No corpo da solicitação, forneça apenas os valores das propriedades que devem ser atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base em alterações em outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Propriedade Tipo Descrição
aboutMe String Um campo de entrada de texto em forma livre para o usuário se descrever.
accountEnabled Booliano true se a conta estiver habilitada; caso contrário, false. Essa propriedade é obrigatória quando um usuário é criado. Um administrador global com a permissão delegada Directory.AccessAsUser.All pode atualizar o status accountEnabled de todos os administradores no locatário.
ageGroup ageGroup Define a faixa etária do usuário. Valores permitidos: null, Minor, NotAdulte Adult. Confira as definições de propriedades da faixa etária legal para obter mais informações.
birthday DateTimeOffset O aniversário do usuário. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z
businessPhones Coleção de cadeias de caracteres Números de telefone para o usuário. OBSERVAÇÃO: embora essa seja uma coleção de cadeias de caracteres, somente um número pode ser definido para essa propriedade.
city String A cidade em que o usuário está localizado.
CompanyName String O nome da empresa que o usuário está associado. Essa propriedade pode ser útil para descrever a empresa de onde procede um usuário externo. O tamanho máximo é de 64 caracteres.
consentProvidedForMinor consentProvidedForMinor Define se o consentimento foi obtido para menores. Valores permitidos: null, Granted, Denied e NotRequired. Confira as definições de propriedades da faixa etária legal para obter mais informações.
country Cadeia de caracteres O país/região em que o usuário está localizado; por exemplo, US ou UK.
customSecurityAttributes customSecurityAttributeValue Um tipo complexo aberto que contém o valor de um atributo de segurança personalizado atribuído a um objeto de diretório.

Para atualizar este imóvel, o responsável pela chamada deve ser designado como Administrador de Atribuição de Atributos e deve receber a permissão CustomSecAttributeAssignment.ReadWrite.All.
department String O nome do departamento no qual o usuário trabalha.
displayName String O nome exibido para o usuário no catálogo de endereços. Geralmente é a combinação do nome, da inicial do nome do meio e do sobrenome do usuário. Essa propriedade é necessária quando um usuário é criado e não pode ser desmarcada durante as atualizações.
employeeId String O identificador de funcionário atribuído ao usuário pela organização. O comprimento máximo é de 16 caracteres.
employeeType String Captura o tipo de trabalhador corporativo. Por exemplo, Employee, Contractor, Consultant ou Vendor. Retornado apenas em $select.
givenName String O nome fornecido (nome) do usuário.
employeeHireDate DateTimeOffset A data de contratação do usuário. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z
employeeLeaveDateTime DateTimeOffset A data e hora em que o usuário saiu ou deixará a organização. O tipo de carimbo de data e hora representa informações de data e hora usando o formato ISO 8601 e está sempre em tempo UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.

Para cenários delegados, o usuário chamador deve ter a função administrador global e o aplicativo de chamada atribuído as permissões User.Read.All e User-LifeCycleInfo.ReadWrite.All delegadas.
employeeOrgData employeeOrgData Representa dados da organização (por exemplo, divisão e costCenter) associados a um usuário.
interests Coleção de cadeias de caracteres Uma lista para o usuário descrever os interesses dele.
jobTitle String O cargo do usuário.
email String O endereço SMTP do usuário, por exemplo, jeff@contoso.com. As alterações nessa propriedade também atualizam a coleção proxyAddresses do usuário para incluir o valor como um endereço SMTP. Para Azure AD contas B2C, essa propriedade pode ser atualizada até 10 vezes com endereços SMTP exclusivos. Não é possível atualizar para null.
mailNickname String O alias de email do usuário. Essa propriedade deve ser especificada quando um usuário é criado.
mobilePhone String O número de celular principal do usuário.
mySite String A URL do site pessoal do usuário.
officeLocation String A localização do escritório no local de trabalho do usuário.
onPremisesExtensionAttributes onPremisesExtensionAttributes Contém extensionAttributes 1-15 para o usuário. Os atributos de extensão individuais não são selecionáveis ou filtrados. Para um usuário do onPremisesSyncEnabled, a fonte de autoridade desse conjunto de propriedades é o local e é somente para leitura. Esses atributos de extensão também são conhecidos como atributos personalizados do Exchange 1-15.
onPremisesImmutableId String Essa propriedade é usada para associar uma conta de usuário Active Directory local ao objeto Microsoft Entra usuário. Essa propriedade deve ser especificada ao criar uma nova conta de usuário no Graph se você estiver usando um domínio federado para a propriedade UPN (userPrincipalName ) do usuário. Importante: Os $caracteres e _ não podem ser usados ao especificar essa propriedade.
otherMails Coleção String Uma lista de endereços de email adicional para o usuário; Por exemplo: ["bob@contoso.com", "Robert@fabrikam.com"].
passwordPolicies String Especifica as políticas de senha do usuário. Este valor é uma enumeração com um valor possível sendo DisableStrongPassword, que permite que senhas mais fracas do que a política padrão sejam especificadas. DisablePasswordExpiration também pode ser especificado. Os dois podem ser especificados juntos; por exemplo: DisablePasswordExpiration, DisableStrongPassword.
passwordProfile PasswordProfile Especifica o perfil de senha do usuário. O perfil contém a senha do usuário. A senha no perfil deve atender a requisitos mínimos, conforme especificado pela propriedade passwordPolicies. Por padrão, é obrigatória uma senha forte. Como uma prática recomendada, sempre defina o forceChangePasswordNextSignIn como true. Isso não pode ser usado para usuários federados.

No acesso delegado, o aplicativo de chamada deve receber a permissão delegada Directory.AccessAsUser.All em nome do usuário conectado. No acesso somente ao aplicativo, o aplicativo de chamada deve receber a permissão User.ReadWrite.All do aplicativo e, pelo menos, a função Administrador de UsuárioMicrosoft Entra.
pastProjects Coleção de cadeias de caracteres Uma lista para o usuário enumerar seus projetos anteriores.
postalCode String O código postal do endereço postal do usuário. O código postal é específico para o país/região do usuário. Nos Estados Unidos, esse atributo contém o CEP.
preferredLanguage String O idioma preferencial do usuário. Deve seguir o Código ISO 639-1; por exemplo, en-US.
responsibilities Coleção de cadeias de caracteres Uma lista para o usuário enumerar suas responsabilidades.
schools Coleção de cadeias de caracteres Uma lista para o usuário enumerar as escolas que frequentava.
skills Coleção de cadeias de caracteres Uma lista para o usuário enumerar suas qualificações.
state String O estado ou município no endereço do usuário.
streetAddress String O endereço do local de trabalho do usuário.
surname String O sobrenome do usuário (nome de família ou sobrenome).
usageLocation String Um código de duas letras (padrão ISO 3166). Obrigatório para os usuários que receberão licenças devido à exigência legal de verificar a disponibilidade de serviços nos países. Os exemplos incluem:US,JP e GB. Não anulável.
userPrincipalName String O nome UPN do usuário. O UPN é um nome de entrada no estilo internet para o usuário com base no RFC 822 padrão da Internet. Por convenção, ele deve ser mapeado para o nome de email do usuário. O formato geral é alias@domain, onde o domínio deve estar presente na coleta de domínios verificados pelo locatário. Os domínios verificados para o locatário podem ser acessados pela propriedade verifiedDomains de organization.
OBSERVAÇÃO: essa propriedade não pode conter caracteres de ênfase. Somente os seguintes caracteres são permitidos A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. Para obter a lista completa de caracteres permitidos, consulte as políticas de nome de usuário.
userType String Um valor de string que pode ser usado para classificar tipos de usuário em seu diretório, como Member e Guest.

Observação

  • As propriedades a seguir não podem ser atualizadas por um aplicativo apenas com permissões de aplicativo: aboutMe, birthday, employeeHireDate, interests, mySite, pastProjects, responsabilidades, escolas e habilidades.
  • Para atualizar as propriedades a seguir, você deve especifique-as em sua própria solicitação PATCH, sem incluir as outras propriedades: aboutMe, birthday, interests, mySite, pastProjects, responsabilidades, escolas e habilidades.

Gerenciar extensões e dados associados

Use essa API para gerenciar o diretório, o esquema e as extensões abertas e seus dados para os usuários, da seguinte maneira:

  • Adicionar, atualizar e armazenar dados nas extensões para um usuário existente
  • Para extensões de diretório e esquema, remova todos os dados armazenados definindo o valor da propriedade de extensão personalizada como null. Para extensões abertas, use a API Excluir a extensão aberta.

Resposta

Se tiver êxito, este método retornará um código de resposta 204 No Content.

Exemplo

Exemplo 1: atualizar as propriedades do usuário conectado

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/v1.0/me
Content-type: application/json

{
  "businessPhones": [
    "+1 425 555 0109"
  ],
  "officeLocation": "18/2111"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Exemplo 2: atualizar as propriedades do usuário especificado

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/v1.0/users/{id}
Content-type: application/json

{
  "businessPhones": [
    "+1 425 555 0109"
  ],
  "officeLocation": "18/2111"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content

Exemplo 3: atualizar a senhaProfile de um usuário e redefinir sua senha

O exemplo a seguir mostra uma solicitação para redefinir a senha de outro usuário. Como uma prática recomendada, sempre defina o forceChangePasswordNextSignIn como true.

Solicitação

PATCH https://graph.microsoft.com/v1.0/users/{id}
Content-type: application/json

{
  "passwordProfile": {
    "forceChangePasswordNextSignIn": false,
    "password": "xWwvJ]6NMw+bWH-d"
  }
}

Resposta

HTTP/1.1 204 No Content

Exemplo 4: Adicionar ou atualizar os valores de uma extensão de esquema para um usuário

Você pode atualizar ou atribuir um valor a uma única propriedade ou a todas as propriedades na extensão.

Solicitação

PATCH https://graph.microsoft.com/v1.0/users/4562bcc8-c436-4f95-b7c0-4f8ce89dca5e
Content-type: application/json

{
    "ext55gb1l09_msLearnCourses": {
        "courseType": "Admin"
    }
}

Para remover o valor da extensão de esquema do objeto de usuário, defina a propriedade ext55gb1l09_msLearnCourses como null.

Resposta

HTTP/1.1 204 No Content

Exemplo 5: atribuir um atributo de segurança personalizado com um valor de cadeia de caracteres a um usuário

O exemplo a seguir mostra como atribuir um atributo de segurança personalizado com um valor de cadeia de caracteres a um usuário.

  • Conjunto de atributos: Engineering
  • Atributo: ProjectDate
  • Tipo de dados de atributo: cadeia de caracteres
  • Valor do atributo: "2022-10-01"

Para atribuir atributos de segurança personalizados, o principal de chamada deve ser atribuído à função de Administrador de Atribuição de Atributo e deve receber a permissão CustomSecAttributeAssignment.ReadWrite.All.

Para obter exemplos de atribuições de atributo de segurança personalizadas, consulte Exemplos: Atribuir, atualizar, listar ou remover atribuições de atributo de segurança personalizadas usando o microsoft API do Graph.

Solicitação

PATCH https://graph.microsoft.com/v1.0/users/{id}
Content-type: application/json

{
    "customSecurityAttributes":
    {
        "Engineering":
        {
            "@odata.type":"#Microsoft.DirectoryServices.CustomSecurityAttributeValue",
            "ProjectDate":"2022-10-01"
        }
    }
}

Resposta

HTTP/1.1 204 No Content