Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
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.
Representa un subtipo especializado de identidad de usuario en Microsoft Entra ID diseñado para aplicaciones con tecnología de inteligencia artificial (agentes) que necesitan funcionar como trabajadores digitales. Los usuarios del agente permiten a los agentes acceder a las API y servicios que requieren específicamente identidades de usuario y reciben tokens con idtyp=user notificaciones. Los usuarios del agente son distintos de los usuarios humanos y solo se interconectan con los usuarios a través de relaciones como propietario, patrocinador y administrador.
Cada usuario del agente mantiene una relación uno a uno con una identidad de agente principal y se autentica a través de las credenciales de ese elemento primario. Los usuarios del agente tienen funcionalidades similares a las de usuario, como agregarse a grupos, licencias asignadas y acceder a características colaborativas como buzones de correo y chat, mientras que funcionan con restricciones de seguridad, como la no autenticación con contraseña, ninguna asignación de roles de administrador con privilegios y permisos similares a los usuarios invitados.
Hereda del usuario.
Este recurso es un tipo abierto que permite propiedades adicionales más allá de las documentadas aquí.
Métodos
| Método | Tipo de valor devuelto | Descripción |
|---|---|---|
| List | colección agentUser | Obtenga una lista de objetos agentUser . |
| Crear | agentUser | Cree un nuevo objeto agentUser . |
| Get | agentUser | Lee las propiedades y las relaciones del objeto agentUser . |
| Actualizar | agentUser | Actualice el objeto agentUser . |
| Delete | Ninguno | Elimina el objeto agentUser . |
| Asignaciones de roles de aplicación | ||
| Enumeración de asignaciones de roles de aplicación | Colección appRoleAssignment | Obtenga las asignaciones de roles de aplicación para este usuario del agente. |
| Creación de una asignación de roles de aplicación | appRoleAssignment | Cree una nueva asignación de roles de aplicación para este usuario del agente. |
| Elementos eliminados | ||
| Lista | Colección directoryObject | Recupere una lista de objetos de usuario del agente eliminados recientemente. |
| Get | directoryObject | Recupere las propiedades de un usuario de agente eliminado recientemente. |
| Restaurar | directoryObject | Restaure un usuario del agente eliminado recientemente. |
| Eliminar permanentemente | Ninguno | Elimine permanentemente un usuario del agente. |
| Objetos de directorio | ||
| Enumerar objetos en propiedad | Colección directoryObject | Obtenga los objetos de directorio propiedad del usuario del agente. |
| Relaciones organizativas | ||
| Enumerar subordinados | Colección directoryObject | Obtenga los usuarios y contactos que informan al usuario del agente. |
| Enumerar administrador | directoryObject | Obtenga el usuario o contacto que es el administrador del usuario del agente. |
| Agregar administrador | Ninguno | Asigne el administrador del usuario del agente. |
| Quitar administrador | Ninguno | Quite el administrador del usuario del agente. |
| Enumerar pertenencias directas | Colección directoryObject | Obtenga los grupos, roles de directorio y unidades administrativas de los que es miembro el usuario del agente. |
| Enumeración de pertenencias transitivas | Colección directoryObject | Obtenga los grupos, roles de directorio y unidades administrativas de los que es miembro el usuario del agente, incluidas las pertenencias a grupos anidados. |
| Enumerar informes transitivos | Colección directoryObject | Obtenga los informes transitivos para el usuario del agente. |
| Patrocinadores | ||
| Enumerar patrocinadores | Colección directoryObject | Obtenga los usuarios y grupos responsables de los privilegios de este usuario del agente. |
| Incorporación de patrocinadores | Ninguno | Agregue patrocinadores para el usuario del agente. |
| Eliminación de patrocinadores | Ninguno | Quite los patrocinadores del usuario del agente. |
Propiedades
Importante
Aunque este recurso hereda del usuario, algunas propiedades no son aplicables y devuelven null o valores predeterminados. Estas propiedades se excluyen de la tabla siguiente.
| Propiedad | Tipo | Descripción |
|---|---|---|
| accountEnabled | Boolean |
true si la cuenta está habilitada; en caso contrario, false. Esta propiedad es necesaria al crear el objeto . Se hereda del usuario. |
| assignedLicenses | Colección assignedLicense | Las licencias que se asignan al usuario del agente, incluidas las licencias heredadas (basadas en grupos). Esta propiedad no diferencia entre las licencias asignadas directamente y las heredadas. Use la propiedad licenseAssignmentStates para identificar las licencias asignadas y heredadas directamente. No admite valores NULL. Se hereda del usuario. |
| assignedPlans | Colección assignedPlan | Planes asignados al usuario del agente. Solo lectura. No admite valores NULL. Se hereda del usuario. |
| businessPhones | Colección string | Números de teléfono para el usuario del agente. Para esta propiedad sólo se puede establecer un número. Solo lectura para los usuarios sincronizados desde un directorio local. Se hereda del usuario. |
| city | Cadena | Ciudad donde se encuentra el usuario del agente. La longitud máxima es de 128 caracteres. Se hereda del usuario. |
| cloudRealtimeCommunicationInfo | cloudRealtimeCommunicationInfo | Información de comunicación en tiempo real de Microsoft relacionada con el usuario del agente. Se hereda del usuario. |
| 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 externo. La longitud máxima es de 64 caracteres. Se hereda del usuario. |
| country | Cadena | País o región donde se encuentra el usuario del agente; por ejemplo, US o UK. La longitud máxima es de 128 caracteres. Se hereda del usuario. |
| createdDateTime | DateTimeOffset | Fecha y hora en que se creó el usuario del agente en formato ISO 8601 y UTC. El valor no puede modificarse y se rellena automáticamente al crear la entidad. Admite valores NULL. Para los usuarios locales, el valor representa cuándo se crearon por primera vez en Microsoft Entra ID. La propiedad es null para algunos usuarios creados antes de junio de 2018 y los usuarios locales sincronizados con Microsoft Entra ID antes de junio de 2018. Solo lectura. Se hereda del usuario. |
| creationType | Cadena | Solo lectura. Nulo. Se hereda del usuario. |
| customSecurityAttributes | customSecurityAttributeValue | Un tipo complejo abierto que contiene el valor de un atributo de seguridad personalizado que se asigna a un objeto de directorio. Admite un valor NULL. Se hereda del usuario. |
| deletedDateTime | DateTimeOffset | Fecha y hora en que se eliminó el usuario. Heredado de directoryObject. |
| department | Cadena | Nombre del departamento donde trabaja el usuario. La longitud máxima es de 64 caracteres. Se hereda del usuario. |
| displayName | Cadena | Nombre del usuario que aparece en la libreta de direcciones. El valor suele ser la combinación del nombre del usuario, la inicial del segundo nombre y el apellido. Esta propiedad es necesaria cuando se crea un usuario y no se puede borrar durante las actualizaciones. La longitud máxima es de 256 caracteres. Se hereda del usuario. |
| employeeHireDate | DateTimeOffset | La fecha y hora en que se contrató al usuario o comenzará a trabajar si hay una contratación futura. Se hereda del usuario. |
| employeeId | Cadena | El identificador de empleado asignado al usuario en la organización. La longitud máxima es de 16 caracteres. Se hereda del usuario. |
| employeeLeaveDateTime | DateTimeOffset | Fecha y hora en que el usuario se fue o dejará la organización. Para leer esta propiedad, a la aplicación que realiza la llamada se le debe asignar el permiso User-LifeCycleInfo.Read.All . Para escribir esta propiedad, a la aplicación que realiza la llamada se le deben asignar los permisos User.Read.All y User-LifeCycleInfo.ReadWrite.All . Para leer esta propiedad en escenarios delegados, el administrador necesita al menos uno de los siguientes roles de Microsoft Entra: Administrador de flujos de vida (privilegios mínimos), Lector global. Para escribir esta propiedad en escenarios delegados, el administrador necesita el rol Administrador global . Para obtener más información, vea Configurar la propiedad employeeLeaveDateTime para un usuario. Se hereda del usuario. |
| employeeOrgData | employeeOrgData | Representa los datos de la organización (por ejemplo, la división y costCenter) asociados a un usuario. Se hereda del usuario. |
| employeeType | Cadena | Es para capturar el tipo de trabajador de la empresa. Por ejemplo, Employee, Contractor, Consultant o Vendor. Se hereda del usuario. |
| faxNumber | Cadena | El número de fax del usuario. Se hereda del usuario. |
| givenName | Cadena | El nombre (nombre de pila) del usuario. La longitud máxima es de 64 caracteres. Se hereda del usuario. |
| id | String | El identificador único del usuario. Debe tratarse como un identificador opaco. Heredado de directoryObject. No admite valores NULL. Solo lectura. Hereda de la entidad |
| identityParentId | Cadena | Hace referencia al identificador de objeto de la identidad del agente asociado. Esta propiedad es necesaria al crear el objeto y no se puede borrar durante las actualizaciones. Se hereda del usuario. |
| imAddresses | Colección string | Las direcciones del protocolo de inicio de sesión (SIP) de ip de voz a través de mensajes instantáneos (VOIP) para el usuario. Solo lectura. Se hereda del usuario. |
| infoCatalogs | Colección de cadenas | Identifica los segmentos de información asignados al usuario. Se hereda del usuario. |
| isLicenseReconciliationNeeded | Booleano | Indica si el usuario está pendiente de una asignación de licencia de buzón de Exchange. Solo lectura. Se hereda del usuario. |
| isManagementRestricted | Booleano |
true si el usuario es miembro de una unidad administrativa de administración restringida. Si no se establece, el valor predeterminado es null y el comportamiento predeterminado es false. Solo lectura. Para administrar un usuario que es miembro de una unidad administrativa de administración restringida, al administrador o a la aplicación de llamada se le debe asignar un rol de Microsoft Entra en el ámbito de la unidad administrativa de administración restringida. Se hereda del usuario. |
| isResourceAccount | Booleano | No se utiliza. Reservado para uso posterior. Se hereda del usuario. |
| jobTitle | String | Puesto del usuario. La longitud máxima es de 128 caracteres. Se hereda del usuario. |
| licenseAssignmentStates | Colección licenseAssignmentState | Estado de asignaciones de licencia para este usuario. También indica las licencias que se asignan directamente y las que el usuario hereda a través de pertenencias a grupos. Solo lectura. Se hereda del usuario. |
| Cadena | La dirección SMTP del usuario (por ejemplo, la dirección admin@contoso.com). Los cambios en esta propiedad también actualizan la colección proxyAddresses del usuario para incluir el valor como una dirección SMTP. Esta propiedad no puede contener caracteres de énfasis. NOTA: No se recomienda actualizar esta propiedad para Azure perfiles de usuario de AD B2C. Use la propiedad otherMails en su lugar. Se hereda del usuario. |
|
| mailNickname | Cadena | El alias de correo del usuario. Esta propiedad debe especificarse al crear un usuario. La longitud máxima es de 64 caracteres. Se hereda del usuario. |
| mobilePhone | String | El número de teléfono móvil principal del usuario. Solo lectura para los usuarios sincronizados desde el directorio local. Se hereda del usuario. |
| officeLocation | String | La ubicación de la oficina del lugar de trabajo del usuario. La longitud máxima es de 128 caracteres. Se hereda del usuario. |
| otherMails | Colección string | Una lista de direcciones de correo electrónico adicionales para el usuario. Por ejemplo: ["bob@contoso.com", "Robert@fabrikam.com"]. Puede almacenar hasta 250 valores, cada uno con un límite de 250 caracteres. NOTA: Esta propiedad no puede contener caracteres de énfasis. Se hereda del usuario. |
| postalCode | String | El código postal de la dirección del usuario. El código postal es específico del país o de la región del usuario. En Estados Unidos, este atributo contiene el código postal. La longitud máxima es de 40 caracteres. Se hereda del usuario. |
| preferredDataLocation | Cadena | La ubicación de datos preferida para el usuario. Para obtener más información, vea OneDrive Online Multi-Geo. Se hereda del usuario. |
| preferredLanguage | String | Idioma preferido del usuario. El formato de idioma preferido se basa en RFC 4646. El nombre combina un código de referencia cultural en minúsculas iso 639 de dos letras asociado al idioma y un código de subcultura en mayúsculas iso 3166 de dos letras asociado al país o región. Ejemplo: "en-US" o "es-ES". Se hereda del usuario. |
| provisionedPlans | colección provisionedPlan | Planes que han sido provisionados para el usuario. Solo lectura. No admite valores NULL. Se hereda del usuario. |
| proxyAddresses | Colección string | Por ejemplo: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]. Los cambios en la propiedad mail también actualizan esta colección para incluir el valor como una dirección SMTP. Para obtener más información, consulte propiedades mail y proxyAddresses. La dirección de proxy con SMTP el prefijo (con mayúsculas) es la dirección de proxy principal, mientras que las que tienen smtp el prefijo son las direcciones proxy secundarias. Para Azure cuentas de AD B2C, esta propiedad tiene un límite de 10 direcciones únicas. Solo lectura en Microsoft Graph; puede actualizar esta propiedad solo a través del Centro de administración de Microsoft 365. No admite valores NULL. Se hereda del usuario. |
| refreshTokensValidFromDateTime | DateTimeOffset | Los tokens de actualización o los tokens de sesiones (cookies de sesión) emitidos antes de este momento no son válidos y las aplicaciones reciben un error al usar un token de actualización o sesiones no válido para adquirir un token de acceso delegado (para acceder a las API como Microsoft Graph). Si sucede, la aplicación debe adquirir un nuevo token de actualización solicitando el punto de conexión autorizado. Solo lectura. Use invalidateAllRefreshTokens para restablecer. Se hereda del usuario. |
| securityIdentifier | Cadena | Identificador de seguridad (SID) del usuario, que se usa en escenarios de Windows. Solo lectura. Se devuelve de forma predeterminada. Se hereda del usuario. |
| showInAddressList | Boolean | No usar en Microsoft Graph. Administre esta propiedad a través de la Centro de administración de Microsoft 365 en su lugar. Representa si el usuario del agente debe incluirse en la lista global de direcciones de Outlook. Consulte Problema conocido. Se hereda del usuario. |
| signInSessionsValidFromDateTime | DateTimeOffset | Los tokens de actualización o los tokens de sesiones (cookies de sesión) emitidos antes de este momento no son válidos y las aplicaciones reciben un error al usar un token de actualización o sesiones no válido para adquirir un token de acceso delegado (para acceder a las API como Microsoft Graph). Si esto ocurre, la aplicación debe adquirir un nuevo token de actualización solicitando el punto de conexión autorizado. Solo lectura. Use revokeSignInSessions para restablecer. Se hereda del usuario. |
| state | Cadena | Estado o provincia en la dirección del usuario del agente. La longitud máxima es de 128 caracteres. Se hereda del usuario. |
| streetAddress | String | Dirección postal del lugar de trabajo del usuario del agente. La longitud máxima es de 1024 caracteres. Se hereda del usuario. |
| surname | Cadena | El apellido (o apellidos) del usuario. La longitud máxima es de 64 caracteres. Se hereda del usuario. |
| usageLocation | String | Código de país de dos letras (norma ISO 3166). Requerido para los usuarios del agente a los que se les asignan licencias debido a los requisitos legales para comprobar la disponibilidad de los servicios en los países. Algunos ejemplos son: USJP y GB. No admite valores NULL. Se hereda del usuario. |
| 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 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@domain, donde el dominio debe estar presente en la colección de dominios verificada del inquilino. Esta propiedad es necesaria cuando se crea un usuario. 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. Se hereda del usuario. |
| userType | Cadena | Valor string que se puede usar para clasificar los tipos de usuario del agente en el directorio. Los valores posibles son Member y Guest.
NOTA: Para obtener más información sobre los permisos para los usuarios invitados y miembros, consulte ¿Cuáles son los permisos de usuario predeterminados en Microsoft Entra ID? Se hereda del usuario. |
Relaciones
Importante
Aunque este tipo de recurso hereda todas las relaciones del tipo de recurso de usuario , algunas relaciones no son aplicables a los usuarios del agente y siempre devolverán null o valores predeterminados. Estas relaciones se excluyen de la tabla siguiente para mayor claridad.
| Relación | Tipo | Description |
|---|---|---|
| appRoleAssignments | Colección appRoleAssignment | Representa los roles de aplicación que se han concedido a un usuario del agente para una aplicación. Heredado del usuario |
| directReports | Colección directoryObject | Los usuarios y contactos que informan al usuario del agente. (Los usuarios y los contactos con su propiedad de administrador establecida en este usuario). Solo lectura. Admite valores NULL. Heredado del usuario |
| manager | directoryObject | El usuario o contacto que es el administrador del usuario del agente. Solo lectura. Heredado del usuario |
| memberOf | Colección directoryObject | Grupos, roles de directorio y unidades administrativas de los que es miembro el usuario del agente. Solo lectura. Admite valores NULL. Heredado del usuario |
| ownedObjects | Colección directoryObject | Objetos de directorio propiedad del usuario del agente. Solo lectura. Admite valores NULL. Heredado del usuario |
| Patrocinadores | Colección directoryObject | Los usuarios y grupos responsables de los privilegios de este usuario del agente en el inquilino y mantienen actualizada la información y el acceso del usuario del agente. (Métodos HTTP: GET, POST, DELETE). Heredado del usuario |
| transitiveMemberOf | Colección directoryObject | Los grupos, incluidos los grupos anidados y los roles de directorio de los que es miembro el usuario del agente. Admite valores NULL. Heredado del usuario |
| transitiveReports | Colección directoryObject | Informes transitivos para un usuario del agente. Solo lectura. Heredado del usuario |
Representación JSON
La siguiente representación JSON muestra el tipo de recurso.
{
"@odata.type": "#microsoft.graph.agentUser",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"accountEnabled": "Boolean",
"assignedLicenses": [
{
"@odata.type": "microsoft.graph.assignedLicense"
}
],
"assignedPlans": [
{
"@odata.type": "microsoft.graph.assignedPlan"
}
],
"businessPhones": [
"String"
],
"city": "String",
"cloudRealtimeCommunicationInfo": {
"@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo"
},
"companyName": "String",
"country": "String",
"countryCode": "Integer",
"createdDateTime": "String (timestamp)",
"creationType": "String",
"customSecurityAttributes": {
"@odata.type": "microsoft.graph.customSecurityAttributeValue"
},
"department": "String",
"displayName": "String",
"employeeHireDate": "String (timestamp)",
"employeeId": "String",
"employeeOrgData": {
"@odata.type": "microsoft.graph.employeeOrgData"
},
"employeeType": "String",
"employeeLeaveDateTime": "String (timestamp)",
"faxNumber": "String",
"givenName": "String",
"imAddresses": [
"String"
],
"infoCatalogs": [
"String"
],
"isLicenseReconciliationNeeded": "Boolean",
"isManagementRestricted": "Boolean",
"isResourceAccount": "Boolean",
"jobTitle": "String",
"licenseAssignmentStates": [
{
"@odata.type": "microsoft.graph.licenseAssignmentState"
}
],
"mail": "String",
"mailNickname": "String",
"mobilePhone": "String",
"otherMails": [
"String"
],
"officeLocation": "String",
"postalCode": "String",
"preferredDataLocation": "String",
"preferredLanguage": "String",
"provisionedPlans": [
{
"@odata.type": "microsoft.graph.provisionedPlan"
}
],
"proxyAddresses": [
"String"
],
"refreshTokensValidFromDateTime": "String (timestamp)",
"securityIdentifier": "String",
"showInAddressList": "Boolean",
"signInSessionsValidFromDateTime": "String (timestamp)",
"state": "String",
"streetAddress": "String",
"surname": "String",
"usageLocation": "String",
"userPrincipalName": "String",
"userType": "String",
"identityParentId": "String"
}