[POST] Synchronize print queue users

This endpoint synchronizes users, keeping the user base in the NDD Orbix portal consistent with the source base from which the API is connected:

Non-existent users will be created in the portal.
Existing users will be updated in the portal.
Users missing from the source base will be deleted from the portal.

If there is no user with the same Logon and Domain, a new user will be created. If there is already a user registered with the same Logon and Domain, but with different Name and/or Email information, the user will be updated.

Call

POST /v1/users/synchronize

Header

Parameter

Description

Type

Mandatory

Tenant

Name of the provider.

For this information, see the documentation: Portal menus.

string

Yes

Authorization

Authentication token obtained.

string

Yes

Body

Parameter	Description	Type	Mandatory
`Client`	Name of the customer, as registered in the NDD Orbix portal.	`string`	Yes
`Users`	List of users.	`array`	Yes
`Logon`	User access identification. Do not use accents, symbols or spaces.	`string`	Yes
`Domain`	Domain to which the user belongs. Do not use accents, symbols or spaces.	`string`	Yes
`Name`	User's full name.	`string`	No
`Email`	User's email address. Example: abc@abc.com.	`string`	No

Example request

Synchronize three users:

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

In the same request, you can synchronise up to 4,500 users.

To synchronise more than 4,500 users, make more than one request.

Example response

The response code 201 indicates that:

all users have been successfully created, updated or deleted and will return the following JSON:

CODE

[]

or

there was a partial failure to create, update or delete some users, and will return the reason for the failure in JSON:

CODE

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

The code 400 response indicates that there was a failure to create, update or delete all users, and will return the following JSON:

CODE

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