Update agentUser

Espacio de nombres: microsoft.graph

Actualice las propiedades de un objeto agentUser .

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Permisos para escenarios específicos

• Su cuenta personal de Microsoft debe estar vinculada a un inquilino de Microsoft Entra para actualizar su perfil con el permiso delegado User.ReadWrite en una cuenta personal de Microsoft.
• Para actualizar la propiedad employeeLeaveDateTime :
  • En escenarios delegados, el administrador necesita el rol de administrador global ; A la aplicación se le deben conceder los permisos delegados User.Read.All y User-LifeCycleInfo.ReadWrite.All .
  • En escenarios de solo aplicación con permisos de Microsoft Graph, se debe conceder a la aplicación los permisos User.Read.All y User-LifeCycleInfo.ReadWrite.All .
• Para actualizar la propiedad customSecurityAttributes :
  • En escenarios delegados, se debe asignar al administrador el rol de administrador de asignación de atributos y a la aplicación se le debe conceder el permiso CustomSecAttributeAssignment.ReadWrite.All .
  • En escenarios de solo aplicación con permisos de Microsoft Graph, se debe conceder a la aplicación el permiso CustomSecAttributeAssignment.ReadWrite.All .
• User-Mail.ReadWrite.All es el permiso con privilegios mínimos para actualizar la propiedad otherMails .
• User-PasswordProfile.ReadWrite.All es el permiso con privilegios mínimos para actualizar la propiedad passwordProfile .
• User-Phone.ReadWrite.All es el permiso con privilegios mínimos para actualizar las propiedades businessPhones y mobilePhone .
• User.EnableDisableAccount.All + User.Read.All es la combinación mínima de permisos para actualizar la propiedad accountEnabled .
• User.ManageIdentities.All es necesario para actualizar la propiedad de identidades .

Solicitud HTTP

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

Encabezados de solicitud

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione solo los valores de las propiedades que se van a actualizar. Las propiedades existentes que no están incluidas en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad.

En la tabla siguiente se especifican las propiedades que se pueden actualizar.

Debe especificar el @odata.type como #microsoft.graph.agentUser en el cuerpo de la solicitud al actualizar un agentUser.

Dado que el recurso agentUser admite extensiones, puede usar la operación para agregar, actualizar o eliminar sus propios datos específicos de la PATCH aplicación en las propiedades personalizadas de una extensión en una instancia de agentUser existente.

Administración de extensiones y datos asociados

Use esta API para administrar el directorio, el esquema y las extensiones abiertas y sus datos para los usuarios del agente, de la siguiente manera:

• Agregar, actualizar y almacenar datos en las extensiones para un usuario de agente existente
• Para las extensiones de directorio y esquema, quite los datos almacenados estableciendo el valor de la propiedad de extensión personalizada en null. Para las extensiones abiertas, use la API Eliminar extensión abierta.

Respuesta

Si tiene éxito, este método devuelve un 200 OK código de respuesta y un objeto agentUser actualizado en el cuerpo de la respuesta.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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 agentUser = {
  '@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(agentUser);

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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