Crear agentUser

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.

Crea un nuevo objeto agentUser . También puede crear un usuario agente mediante el punto de conexión POST /users y especificando el microsoft.graph.agentUser tipo en el cuerpo de la solicitud.

Como mínimo, debe especificar las propiedades necesarias. De forma opcional, puede especificar cualquier otra propiedad modificable.

Esta operación devuelve, de forma predeterminada, solo un subconjunto de las propiedades de cada agentUser. Las propiedades predeterminadas se indican en la sección de propiedades. Para obtener propiedades que no se devuelven de forma predeterminada, realice una operación GET y especifique las propiedades de una opción de consulta de OData $select.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ✅ ✅ ✅

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.

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

Importante

Para el acceso delegado con cuentas profesionales o educativas, el administrador debe tener asignado un rol compatible de Microsoft Entra o un rol personalizado que conceda los permisos necesarios para esta operación. El administrador de ID de agente es el rol con menos privilegios admitido para esta operación.

Solicitud HTTP

POST /users/microsoft.graph.agentUser

Sugerencia

También puede crear usuarios de agente a través del POST /users sin especificar el microsoft.graph.agentUser tipo. Sin embargo, "@odata.type": "microsoft.graph.agentUser" debe especificarse en el cuerpo de la solicitud junto con otras propiedades necesarias para la creación del usuario.

Encabezados de solicitud

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

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto agentUser .

La siguiente tabla enumera las propiedades que se requieren cuando se crea un agentUser.

Parámetro Tipo Descripción
accountEnabled Boolean true si la cuenta está habilitada; en caso contrario, false.
displayName Cadena Nombre que se mostrará en la libreta de direcciones para el usuario agente.
mailNickname Cadena El alias de correo del usuario agente.
userPrincipalName Cadena El nombre principal del usuario (someagent@contoso.com). Es un nombre de inicio de sesión de estilo Internet para el usuario agente basado en el estándar de Internet RFC 822. Por convención, esto debe asignarse al nombre de correo electrónico del usuario 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.
identityParentId Cadena El identificador de objeto de la identidad del agente asociado. Obligatorio.

Dado que este recurso admite extensiones, puede utilizar la POST operación y agregar propiedades personalizadas con sus propios datos a la instancia de usuario del agente mientras la crea.

Respuesta

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

Al intentar crear un agentUser con un identityParentId ya vinculado a otro agentUser, se devuelve un 400 Bad Request error.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

POST https://graph.microsoft.com/beta/users/microsoft.graph.agentUser
Content-type: application/json

{
  "accountEnabled": true,
  "displayName": "Sales Agent",
  "mailNickname": "SalesAgent",
  "userPrincipalName": "salesagent@contoso.com",
  "identityParentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

El objeto de respuesta que se muestra aquí puede estar acortado para mejorar la legibilidad.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users/$entity",
    "@odata.type": "#microsoft.graph.agentUser",
    "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
    "businessPhones": [],
    "displayName": "Sales Agent",
    "mail": "salesagent@contoso.com",
    "mailNickname": "SalesAgent",
    "userPrincipalName": "salesagent@contoso.com",
    "identityParentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Contenido relacionado

  • Last updated on