Update agentUser

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 agentUser .

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ão com privilégios mínimos Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) AgentIdUser.ReadWrite.IdentityParentedBy AgentIdUser.ReadWrite.All, User.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application AgentIdUser.ReadWrite.IdentityParentedBy AgentIdUser.ReadWrite.All, User.ReadWrite.All

Permissões para cenários específicos

  • Sua conta Microsoft pessoal deve ser vinculada a um locatário do Microsoft Entra para atualizar seu perfil com a permissão delegada User.ReadWrite em uma conta Microsoft pessoal.
  • Para atualizar a propriedade employeeLeaveDateTime :
    • Em cenários delegados, o administrador precisa da função de Administrador Global ; o aplicativo deve receber as permissões delegadas User.Read.All e User-LifeCycleInfo.ReadWrite.All .
    • Em cenários somente de aplicativo com permissões do Microsoft Graph, o aplicativo deve receber as permissões User.Read.All e User-LifeCycleInfo.ReadWrite.All .
  • Para atualizar a propriedade customSecurityAttributes :
    • Em cenários delegados, o administrador deve receber a função de Administrador de Atribuição de Atributo e o aplicativo deve receber a permissão CustomSecAttributeAssignment.ReadWrite.All .
    • Em cenários somente de aplicativo com permissões do Microsoft Graph, o aplicativo deve receber a permissão CustomSecAttributeAssignment.ReadWrite.All .
  • User-Mail.ReadWrite.All é a permissão menos privilegiada para atualizar a propriedade otherMails .
  • User-PasswordProfile.ReadWrite.All é a permissão menos privilegiada para atualizar a propriedade passwordProfile .
  • User-Phone.ReadWrite.All é a permissão menos privilegiada para atualizar as propriedades businessPhones e mobilePhone .
  • User.EnableDisableAccount.All + User.Read.All é a combinação menos privilegiada de permissões para atualizar a propriedade accountEnabled .
  • User.ManageIdentities.All é necessário para atualizar a propriedade de identidades .

Solicitação HTTP

PATCH /users/microsoft.graph.agentUser/{userId}

Dica

Você também pode atualizar os usuários do agente por meio do endpoint PATCH /users/{id} sem especificar o microsoft.graph.agentUser tipo.

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 apenas os valores das propriedades a serem 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 nas alterações de outros valores de propriedade.

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

Você deve especificar o @odata.type como #microsoft.graph.agentUser no corpo da solicitação ao atualizar um agentUser.

Propriedade Tipo Descrição
accountEnabled Booliano true se a conta estiver habilitada; caso contrário, false. Esta propriedade é necessária quando um usuário agente é criado.
assignedLicenses Coleção assignedLicense As licenças atribuídas ao usuário agente. Não anulável.
businessPhones String collection Os números de telefone do usuário agente. OBSERVAÇÃO: Embora se trata de uma coleção de cadeias de caracteres, somente um número pode ser definido para essa propriedade.
city Cadeia de caracteres A cidade na qual o usuário agente está localizado.
CompanyName String O nome da empresa à qual o usuário agente está associado. Essa propriedade pode ser útil para descrever a empresa de onde vem um usuário de agente externo. O tamanho máximo é de 64 caracteres.
country Cadeia de caracteres O país/região em que o usuário agente está localizado; por exemplo, US ou UK.
department String O nome do departamento no qual o usuário agente trabalha.
displayName Cadeia de caracteres O nome exibido no catálogo de endereços do usuário agente. Essa propriedade é necessária quando um usuário agente é criado e não pode ser limpa durante atualizações.
employeeId String O identificador do funcionário atribuído ao usuário agente 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.
givenName Cadeia de caracteres O nome próprio (nome) do usuário agente.
employeeHireDate DateTimeOffset A data de contratação do usuário agente. 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 a hora em que o usuário agente saiu ou deixará a organização. O tipo de carimbo de data/hora 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.
employeeOrgData employeeOrgData Representa os dados da organização (por exemplo, divisão e costCenter) associados ao usuário agente. Inclua ambos os valores de propriedade ao atualizar employeeOrgData; Se você omitir algumas, o sistema as definirá como null.
jobTitle String O cargo do usuário agente.
email String O endereço SMTP para o usuário agente, por exemplo, salesagent@contoso.com. As alterações nessa propriedade também atualizam a coleção proxyAddresses do usuário do agente para incluir o valor como um endereço SMTP. Não é possível atualizar para null.
mailNickname String O alias de email para o usuário agente. Essa propriedade deve ser especificada quando um usuário agente é criado.
mobilePhone String O número de telefone celular principal do usuário agente.
officeLocation String O local do escritório no local de negócios do usuário do agente.
otherMails Coleção String Uma lista de endereços de e-mail adicionais para o usuário agente; Por exemplo: ["salesagent@contoso.com", "agentsales@fabrikam.com"]. Para atualizar esta propriedade, passe todos os endereços de e-mail que você deseja que o usuário agente tenha; Caso contrário, os valores existentes serão substituídos pelos valores especificados. Pode armazenar até 250 valores, cada um com um limite de 250 caracteres.
postalCode Cadeia de caracteres O código postal do endereço postal do usuário agente. O CEP é específico do país/região do usuário do agente. Nos Estados Unidos, esse atributo contém o CEP.
preferredLanguage Cadeia de caracteres O idioma preferencial para o usuário agente. Deve seguir o Código ISO 639-1; por exemplo, en-US.
state Cadeia de caracteres O estado ou província no endereço do usuário do agente.
streetAddress String O endereço do local de negócios do usuário do agente.
surname Cadeia de caracteres O sobrenome do usuário do agente (sobrenome ou sobrenome).
usageLocation String Um código de duas letras (padrão ISO 3166). Necessário para usuários agentes que receberão licenças devido a exigência legal de marcar a disponibilidade dos serviços nos países/regiões. Os exemplos incluem:US,JP e GB. Não anulável.
userPrincipalName Cadeia de caracteres O nome UPN do usuário agente. O UPN é um nome de entrada no estilo da Internet para o usuário agente com base no padrão da Internet RFC 822. Por convenção, isso deve mapear para o nome de e-mail do usuário do agente. 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: esta propriedade não pode conter caracteres de acento. 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.

Como o recurso agentUser dá suporte a extensões, você pode usar a PATCH operação para adicionar, atualizar ou excluir seus próprios dados específicos do aplicativo em propriedades personalizadas de uma extensão em uma instância de agentUser existente.

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 usuários do agente, da seguinte maneira:

  • Adicione, atualize e armazene dados nas extensões para um usuário agente 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 for bem-sucedido, esse método retornará um código de 200 OK resposta e um objeto agentUser atualizado no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

PATCH https://graph.microsoft.com/beta/users/microsoft.graph.agentUser/{userId}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.agentUser",
  "accountEnabled": true,
  "assignedLicenses": [
    {
      "@odata.type": "microsoft.graph.assignedLicense"
    }
  ],
  "businessPhones": [
    "+1 425 555 0109"
  ],
  "city": "Seattle",
  "companyName": "Contoso",
  "country": "United States",
  "department": "Sales",
  "displayName": "Sales Agent",
  "employeeId": "12345",
  "employeeType": "Agent",
  "givenName": "Sales",
  "employeeHireDate": "2024-01-15T00:00:00Z",
  "employeeLeaveDateTime": null,
  "employeeOrgData": {
    "@odata.type": "microsoft.graph.employeeOrgData",
    "division": "Sales Division",
    "costCenter": "1234"
  },
  "jobTitle": "Sales Agent",
  "mail": "salesagent@contoso.com",
  "mailNickname": "SalesAgent",
  "mobilePhone": "+1 425 555 0110",
  "officeLocation": "18/2111",
  "otherMails": [
    "salesagent@contoso.com"
  ],
  "postalCode": "98052",
  "preferredLanguage": "en-US",
  "state": "WA",
  "streetAddress": "9256 Towne Center Dr., Suite 400",
  "surname": "Agent",
  "usageLocation": "US",
  "userPrincipalName": "salesagent@contoso.com",
  "userType": "Member"
}

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

{
  "@odata.type": "#microsoft.graph.agentUser",
  "id": "929393ae-1e1d-159f-0d83-29f7df42e7b9",
  "signInActivity": {
    "@odata.type": "microsoft.graph.signInActivity"
  },
 "cloudLicensing": {
      "@odata.type": "microsoft.graph.cloudLicensing.userCloudLicensing"
    },
    "accountEnabled": "Boolean",
    "ageGroup": null,
    "assignedLicenses": [
      {
        "@odata.type": "microsoft.graph.assignedLicense"
      }
    ],
    "assignedPlans": [
      {
        "@odata.type": "microsoft.graph.assignedPlan"
      }
    ],
    "authorizationInfo": null,
    "businessPhones": [
      "String"
    ],
    "city": "String",
    "cloudRealtimeCommunicationInfo": {
      "@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo"
    },
    "companyName": "String",
    "consentProvidedForMinor": null,
    "country": "String",
    "createdDateTime": "String (timestamp)",
    "creationType": "String",
    "department": "String",
    "displayName": "String",
    "employeeHireDate": "String (timestamp)",
    "employeeId": "String",
    "employeeOrgData": {
      "@odata.type": "microsoft.graph.employeeOrgData"
    },
    "employeeType": "String",
    "employeeLeaveDateTime": "String (timestamp)",
    "faxNumber": "String",
    "givenName": "String",
    "identities": [
      {
        "@odata.type": "microsoft.graph.objectIdentity"
      }
    ],
    "imAddresses": [
      "String"
    ],
    "infoCatalogs": [
      "String"
    ],
    "isLicenseReconciliationNeeded": "Boolean",
    "isManagementRestricted": "Boolean",
    "isResourceAccount": "Boolean",
    "jobTitle": "String",
    "lastPasswordChangeDateTime": null,
    "legalAgeGroupClassification": null,
    "licenseAssignmentStates": [
      {
        "@odata.type": "microsoft.graph.licenseAssignmentState"
      }
    ],
    "mail": "String",
    "mailNickname": "String",
    "mobilePhone": "String",
    "onPremisesDistinguishedName": null,
    "onPremisesExtensionAttributes": null,
    "onPremisesImmutableId": null,
    "onPremisesLastSyncDateTime": null,
    "onPremisesProvisioningErrors": null,
    "onPremisesSecurityIdentifier": null,
    "onPremisesSipInfo": null,
    "onPremisesSyncEnabled": null,
    "onPremisesDomainName": null,
    "onPremisesSamAccountName": null,
    "onPremisesUserPrincipalName": null,
    "otherMails": [
      "String"
    ],
    "passwordPolicies": null,
    "passwordProfile": null,
    "officeLocation": "String",
    "postalCode": "String",
    "preferredDataLocation": "String",
    "preferredLanguage": "String",
    "provisionedPlans": [
      {
        "@odata.type": "microsoft.graph.provisionedPlan"
      }
    ],
    "proxyAddresses": [
      "String"
    ],
    "refreshTokensValidFromDateTime": "String (timestamp)",
    "securityIdentifier": "String",
    "serviceProvisioningErrors": [
      {
        "@odata.type": "microsoft.graph.serviceProvisioningXmlError"
      }
    ],
    "showInAddressList": "Boolean",
    "signInSessionsValidFromDateTime": "String (timestamp)",
    "state": "String",
    "streetAddress": "String",
    "surname": "String",
    "usageLocation": "String",
    "userPrincipalName": "String",
    "externalUserState": null,
    "externalUserStateChangeDateTime": null,
    "userType": "String",
    "identityParentId": "String",
    "mailboxSettings": {
      "@odata.type": "microsoft.graph.mailboxSettings"
    },
    "aboutMe": "String",
    "birthday": "String (timestamp)",
    "interests": [
      "String"
    ],
    "mySite": "String",
    "pastProjects": [
      "String"
    ],
    "preferredName": "String",
    "responsibilities": [
      "String"
    ],
    "schools": [
      "String"
    ],
    "skills": [
      "String"
    ]
  }
  • Last updated on