Atualizar personname

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.

Atualizar as propriedades de um objeto personName no perfil de um usuário.

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

A tabela a seguir mostra as propriedades que podem ser atualizadas em um objeto personName existente no perfil de um usuário.

Propriedade Tipo Descrição
allowedAudiences Cadeia de caracteres Os públicos que podem ver os valores contidos na entidade. Herdado de itemFacet. Os valores possíveis são: me, family, contacts, groupMembersorganization, , federatedOrganizations, , everyone, . unknownFutureValue
displayName Cadeia de caracteres Fornece uma renderização ordenada de firstName e lastName, dependendo da localidade do usuário ou do dispositivo.
primeiro Cadeia de caracteres Nome do usuário.
de inferência inferenceData Contém detalhes de inferência se a entidade for inferida pelo aplicativo de criação ou modificação. Herdado de itemFacet.
initials String Iniciais do usuário.
languageTag Cadeia de caracteres Contém o nome do idioma (en-US, no-NB, en-AU) seguindo o formato IETF BCP47.
por último Cadeia de caracteres Sobrenome do usuário.
Donzela Cadeia de caracteres Nome de solteira do usuário.
meio Cadeia de caracteres Nome do meio do usuário.
apelido Cadeia de caracteres Apelido do usuário.
Pronúncia yomiPersonName Diretrizes sobre como pronunciar o nome do usuário.
sufixo Cadeia de caracteres Designadores usados após o nome do usuário (por exemplo: PhD.)
title Cadeia de caracteres Honoríficos usados para prefixar o nome de um usuário (por exemplo: Dr, Senhor, Senhora, Sra.)

Resposta

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

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

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

{
  "nickname": "Kesha"
}

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

{
  "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"
  }
}