Partilhar via


Atualizar o nome da pessoa

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 as propriedades de um objeto personName no perfil de um utilizador.

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

Solicitação HTTP

PATCH /me/profile/names/{id}
PATCH /users/{id | userPrincipalName}/profile/names/{id}

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 mantêm os valores anteriores ou são recalculadas com base em alterações a outros valores de propriedade. Para alcançar o melhor desempenho, não inclua valores existentes que não foram alterados.

A tabela seguinte mostra as propriedades que são possíveis de atualizar dentro de um objeto personName existente no perfil de um utilizador.

Propriedade Tipo Descrição
allowedAudiences Cadeia de caracteres As audiências que conseguem ver os valores contidos na entidade. Herdado do itemFacet. Os valores possíveis são: me, , contactsfamily, , organizationgroupMembers, federatedOrganizations, , . unknownFutureValueeveryone
displayName Cadeia de caracteres Fornece uma composição ordenada de firstName e lastName, dependendo da região do utilizador ou do respetivo dispositivo.
primeiro Cadeia de caracteres Nome próprio do utilizador.
inferência inferenceData Contém detalhes de inferência se a entidade for inferida pela aplicação de criação ou modificação. Herdado do itemFacet.
initials String Iniciais do utilizador.
languageTag Cadeia de caracteres Contém o nome do idioma (en-US, no-NB, en-AU) seguindo o formato IETF BCP47.
último Cadeia de caracteres Apelido do utilizador.
donzela Cadeia de caracteres Nome de solteira do utilizador.
meio Cadeia de caracteres Nome do meio do utilizador.
alcunha Cadeia de caracteres Alcunha do utilizador.
pronúncia yomiPersonName Documentação de orientação sobre como pronunciar o nome dos utilizadores.
sufixo Cadeia de caracteres Designadores utilizados após o nome dos utilizadores (por exemplo: PhD.)
title Cadeia de caracteres Honoríficos utilizados para prefixar o nome de um utilizador (por exemplo: Dr. Senhor, Senhora, Sra.)

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto personName atualizado no corpo da resposta.

Exemplos

Solicitação

Eis um exemplo do pedido.

PATCH https://graph.microsoft.com/beta/me/profile/names/{id}
Content-type: application/json

{
  "nickname": "Kesha"
}

Resposta

Veja um exemplo de resposta.

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

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "0fb4c1e3-c1e3-0fb4-e3c1-b40fe3c1b40f",
  "allowedAudiences": "organization",
  "inference": null,
  "createdDateTime": "2020-07-06T06:34:12.2294868Z",
  "createdBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "lastModifiedDateTime": "2020-07-06T06:34:12.2294868Z",
  "lastModifiedBy": {
    "application": null,
    "device": null,
    "user": {
      "displayName": "Innocenty Popov",
      "id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
    }
  },
  "displayName": "Innocenty Popov",
  "first": "Innocenty",
  "initials": "IP",
  "last": "Popov",
  "languageTag": "en-US",
  "maiden": null,
  "middle": null,
  "nickname": "Kesha",
  "suffix": null,
  "title": null,
  "pronunciation": {
    "displayName": "In-no ken-te ",
    "first": "In-no ken-te Pop-ov",
    "maiden": null,
    "middle": null,
    "last": "Pop-ov"
  }
}