[POST] Sincronizar usuarios de cola de impresión

Este endpoint sincroniza los usuarios, manteniendo la base de usuarios en el portal de NDD Orbix consistente con la base de origen desde la que se conecta la API:

Los usuarios no existentes se crearán en el portal.
Los usuarios existentes se actualizarán en el portal.
Los usuarios que falten en la base de origen se eliminarán del portal.

Si no hay ningún usuario con el mismo Logon y Domain, se creará un nuevo usuario. Si ya hay un usuario registrado con el mismo Logon y Domain, pero con información diferente de Name y/o Email, se actualizará el usuario.

Llamada

POST /v1/users/synchronize

Parámetro

Descripción

Tipo

Obligatorio

Tenant

Nombre del distribuidor.

Para obtener esta información, consulte la documentación: Menús del portal.

string

Sí

Authorization

Token de autenticación obtenido.

string

Sí

Cuerpo (body)

Parámetro	Descripción	Tipo	Obligatorio
`Client`	Nombre del cliente, tal y como está registrado en el portal NDD Orbix.	`string`	Sí
`Users`	Lista de usuarios.	`array`	Sí
`Logon`	Identificación de acceso del usuario. No utilice acentos, símbolos y espacios.	`string`	Sí
`Domain`	Dominio al que pertenece el usuario. No utilice acentos, símbolos y espacios.	`string`	Sí
`Name`	Nombre completo del usuario.	`string`	No
`Email`	Dirección de correo electrónico del usuario. Ejemplo: abc@abc.com.	`string`	No

Ejemplo de solicitud

Sincronizar tres usuarios:

CODE

curl -L -X POST 'https://developer.nddorbix.com/printqueue-external-integration-api/v1/users/synchronize' \
-H 'Tenant: {tenant}' \
-H 'Authorization: Bearer {token}' \
-H 'Content-Type: application/json' \
--data-raw '{
    "Client": "ABC",
    "Users": [
        {
            "Logon": "carlos.silva",
            "Domain": "NDD",
            "Name": "Carlos Silva",
            "Email": "carlos.silva@ndd.tech"
        },
        {
            "Logon": "joao.souza",
            "Domain": "NDD",
            "Name": "João Souza"
        },
        {
            "Logon": "maria.oliveira",
            "Domain": "NDD",
            "Email": "maria.oliveira@ndd.tech"
        }
    ]
}'

En una única solicitud puede sincronizar hasta 4.500 usuarios.

Para sincronizar más de 4.500 usuarios, realice más de una solicitud.

Ejemplo de respuesta

El código de respuesta 201 indica que:

todos los usuarios han sido creados, actualizados o eliminados correctamente y devolverá el siguiente JSON:

CODE

[]

o

se ha producido un fallo parcial en la creación, actualización o eliminación de algunos usuarios y devolverá el motivo del fallo en JSON:

CODE

[
    {
        "user": "NDD//carlos silva",
        "errorMessage": "Logon is not valid."
    },
    {
        "user": "N D D//joao.souza",
        "errorMessage": "Domain is not valid."
    }
]

La respuesta de código 400 indica que hubo un fallo al crear, actualizar o eliminar todos los usuarios, y devolverá el siguiente JSON:

CODE

{
    "errors": {
        "3400": [
            "All users are invalid"
        ]
    },
    "title": "BadRequest",
    "status": 400,
    "detail": "BusinessException",
    "instance": "/v1/users/synchronize"
}

Llamada

Cabecera (header)

Cuerpo (body)

Ejemplo de solicitud

Ejemplo de respuesta