Compartir a través de

Actualizar agenteUsuario

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Actualice las propiedades de un objeto agentUser .

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores 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.

Tipo de permiso Permiso con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) AgentIdUser.ReadWrite.IdentityParentedBy AgentIdUser.ReadWrite.All, User.ReadWrite.All
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación AgentIdUser.ReadWrite.IdentityParentedBy AgentIdUser.ReadWrite.All, User.ReadWrite.All

Permisos para escenarios específicos

  • Su cuenta personal de Microsoft debe estar asociada a un inquilino de Microsoft Entra para actualizar su perfil con el permiso delegado User.ReadWrite en una cuenta microsoft personal.
  • Para actualizar la propiedad employeeLeaveDateTime :
    • En escenarios delegados, el administrador necesita el rol Administrador global ; Se deben conceder a la aplicación los permisos delegados User.Read.All y User-LifeCycleInfo.ReadWrite.All .
    • En escenarios de solo aplicación con permisos de Microsoft Graph, se deben conceder a la aplicación los permisos User.Read.All y User-LifeCycleInfo.ReadWrite.All .
  • Para actualizar la propiedad customSecurityAttributes :
    • En escenarios delegados, al administrador se le debe asignar el rol Administrador de asignación de atributos y a la aplicación se le concede 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 de permisos con privilegios mínimos para actualizar la propiedad accountEnabled .
  • User.ManageIdentities.All es necesario para actualizar la propiedad identities .

Solicitud HTTP

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

Sugerencia

También puede actualizar los usuarios del agente a través del punto de conexión PATCH /users/{id} sin especificar el microsoft.graph.agentUser tipo.

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type application/json. Obligatorio.

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 se incluyen 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.

Propiedad Tipo Descripción
accountEnabled Boolean true si la cuenta está habilitada; en caso contrario, false. Esta propiedad es necesaria cuando se crea un usuario del agente.
assignedLicenses Colección assignedLicense Licencias asignadas al usuario del agente. No admite valores NULL.
businessPhones Colección string Números de teléfono para el usuario del agente. NOTA: Aunque se trata de una colección de cadenas, solo se puede establecer un número para esta propiedad.
city Cadena Ciudad en la que se encuentra el usuario del agente.
CompanyName String Nombre de la empresa a la que está asociado el usuario del agente. Esta propiedad puede ser útil para describir la empresa de la que procede un usuario de agente externo. La longitud máxima es de 64 caracteres.
country Cadena País o región en el que se encuentra el usuario del agente; por ejemplo, US o UK.
department Cadena Nombre del departamento en el que trabaja el usuario del agente.
displayName Cadena Nombre que se muestra en la libreta de direcciones del usuario del agente. Esta propiedad es necesaria cuando se crea un usuario del agente y no se puede borrar durante las actualizaciones.
employeeId Cadena Identificador de empleado asignado al usuario del agente por la organización. La longitud máxima es de 16 caracteres.
employeeType Cadena Es para capturar el tipo de trabajador de la empresa. Por ejemplo, Employee, Contractor, Consultant o Vendor.
givenName Cadena Nombre dado (nombre) del usuario del agente.
employeeHireDate DateTimeOffset Fecha de contratación del usuario del agente. El tipo de marca de tiempo representa la información de fecha y hora con el formato ISO 8601 y está siempre en hora UTC. Por ejemplo, la medianoche en la zona horaria UTC del 1 de enero de 2014 sería 2014-01-01T00:00:00Z.
employeeLeaveDateTime DateTimeOffset Fecha y hora en que el usuario del agente se marchó o dejará la organización. El tipo de marca de tiempo representa la información de fecha y hora con el formato ISO 8601 y siempre está en hora UTC. Por ejemplo, la medianoche en la zona horaria UTC del 1 de enero de 2014 sería 2014-01-01T00:00:00Z.
employeeOrgData employeeOrgData Representa los datos de la organización (por ejemplo, la división y costCenter) asociados al usuario del agente. Incluya ambos valores de propiedad al actualizar employeeOrgData; Si omite alguno, el sistema los establece en null.
jobTitle Cadena El título del trabajo del usuario del agente.
mail Cadena La dirección SMTP del usuario del agente, por ejemplo, salesagent@contoso.com. Los cambios en esta propiedad también actualizan la colección proxyAddresses del usuario del agente para incluir el valor como una dirección SMTP. No se puede actualizar a null.
mailNickname Cadena Alias de correo para el usuario del agente. Esta propiedad debe especificarse cuando se crea un usuario del agente.
mobilePhone String Número de teléfono móvil principal para el usuario del agente.
officeLocation String Ubicación de la oficina en el lugar de negocio del usuario del agente.
otherMails Colección string Una lista de direcciones de correo electrónico adicionales para el usuario del agente; por ejemplo: ["salesagent@contoso.com", "agentsales@fabrikam.com"]. Para actualizar esta propiedad, pase todas las direcciones de correo electrónico que desea que tenga el usuario del agente; De lo contrario, los valores existentes se sobrescriben mediante los valores especificados. Puede almacenar hasta 250 valores, cada uno con un límite de 250 caracteres.
postalCode String El código postal de la dirección postal del usuario del agente. El código postal es específico del país o región del usuario del agente. En Estados Unidos, este atributo contiene el código postal.
preferredLanguage Cadena Idioma preferido para el usuario del agente. Debe seguir el código ISO 639-1; por ejemplo, en-US.
state Cadena Estado o provincia en la dirección del usuario del agente.
streetAddress String Dirección postal del lugar de trabajo del usuario del agente.
surname Cadena Apellido del usuario del agente (nombre de familia o apellido).
usageLocation Cadena Un código de país de dos letras (norma ISO 3166). Se requiere para los usuarios del agente a los que se les asignarán licencias debido a los requisitos legales para comprobar la disponibilidad de los servicios en países o regiones. Algunos ejemplos son: USJP y GB. No admite valores NULL.
userPrincipalName Cadena Nombre principal de usuario (UPN) del usuario del agente. El UPN es un nombre de inicio de sesión de estilo Internet para el usuario del agente basado en la RFC 822 estándar de Internet. Por convención, debe asignarse al nombre de correo electrónico del usuario del agente. El formato general es alias@dominio, en donde el dominio debe estar presente en la colección de dominios verificados del espacio empresarial. Se puede acceder a los dominios verificados del inquilino desde la propiedad verifiedDomains en organización.
NOTA: Esta propiedad no puede contener caracteres de énfasis. Los caracteres siguientes no están permitidos A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. Para obtener la lista completa de caracteres permitidos, vea directivas de nombre de usuario.
userType Cadena Un valor de cadena puede utilizarse para clasificar los tipos de usuario en el directorio. Por ejemplo: Member e Guest.

Dado que el recurso agentUser admite extensiones, puede usar la PATCH operación para agregar, actualizar o eliminar sus propios datos específicos de la aplicación en 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 de 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 se ejecuta correctamente, 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"
}

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"
    ]
  }
  • Last updated on