Agente de atualizaçãoUtilizar

Namespace: microsoft.graph

Atualize as propriedades de um objeto agentUser .

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.

Permissões para cenários específicos

• A sua conta Microsoft pessoal tem de estar associada a um inquilino Microsoft Entra para atualizar o seu perfil com a permissão delegada User.ReadWrite numa conta Microsoft pessoal.
• Para atualizar a propriedade employeeLeaveDateTime :
  • Em cenários delegados, o administrador precisa da função de Administrador Global ; a aplicação tem de ter as permissões delegadas User.Read.All e User-LifeCycleInfo.ReadWrite.All .
  • Em cenários apenas de aplicações com permissões do Microsoft Graph, a aplicação tem de ter as permissões User.Read.All e User-LifeCycleInfo.ReadWrite.All .
• Para atualizar a propriedade customSecurityAttributes :
  • Em cenários delegados, tem de ser atribuída ao administrador a função Administrador de Atribuição de Atributos e a aplicação concedeu a permissão CustomSecAttributeAssignment.ReadWrite.All .
  • Em cenários apenas de aplicações com permissões do Microsoft Graph, a aplicação tem de ter a permissão CustomSecAttributeAssignment.ReadWrite.All .
• User-Mail.ReadWrite.All é a permissão com menos privilégios para atualizar a propriedade otherMails .
• User-PasswordProfile.ReadWrite.All é a permissão com menos privilégios para atualizar a propriedade passwordProfile .
• User-Phone.ReadWrite.All é a permissão com menos privilégios 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 identities .

Solicitação HTTP

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

Cabeçalhos de solicitação

Corpo da solicitação

No corpo do pedido, forneça apenas os valores das propriedades a atualizar. 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.

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

Tem de especificar o @odata.type como #microsoft.graph.agentUser no corpo do pedido ao atualizar um agentUser.

Uma vez que o recurso agentUser suporta extensões, pode utilizar a PATCH operação para adicionar, atualizar ou eliminar os seus próprios dados específicos da aplicação em propriedades personalizadas de uma extensão numa instância agentUser existente.

Gerenciar extensões e dados associados

Utilize esta API para gerir o diretório, o esquema e as extensões abertas e os respetivos dados para utilizadores de agentes, da seguinte forma:

• Adicionar, atualizar e armazenar dados nas extensões de um utilizador de 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, este método devolve um 200 OK código de 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"
}

const options = {
	authProvider,
};

const client = Client.init(options);

const response = {
  '@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'
};

await client.api('/users/microsoft.graph.agentUser/{userId}')
	.version('beta')
	.update(response);

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