[POST] Sincronizar usuários de filas de impressão

Este endpoint sincroniza usuários, mantendo a base de usuários no portal NDD Orbix consistente com a base de origem da qual a API está conectada:

Usuários inexistentes serão criados no portal.
Usuários existentes serão atualizados no portal.
Usuários ausentes na base de origem serão excluídos do portal.

Caso não exista nenhum usuário com o mesmo Logon e Domain, um novo usuário será criado. Se já houver um usuário cadastrado com o mesmo Logon e Domain, mas com informações diferentes de Name e/ou Email, o usuário será atualizado.

Chamada

POST /v1/users/synchronize

Parâmetro

Descrição

Tipo

Obrigatório

Tenant

Nome do provedor.

Para obter essa informação, acesse a documentação: Menus do portal.

string

Sim

Authorization

Token de autenticação obtido.

string

Sim

Corpo (body)

Parâmetro	Descrição	Tipo	Obrigatório
`Client`	Nome do cliente, conforme cadastrado no portal NDD Orbix.	`string`	Sim
`Users`	Lista de usuários.	`array`	Sim
`Logon`	Identificação de acesso do usuário. Não utilize acentos, símbolos e espaços.	`string`	Sim
`Domain`	Domínio ao qual o usuário pertence. Não utilize acentos, símbolos e espaços.	`string`	Sim
`Name`	Nome completo do usuário.	`string`	Não
`Email`	E-mail do usuário. Exemplo: abc@abc.com.	`string`	Não

Exemplo de requisição

Sincronizar três usuários:

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

Em uma mesma requisição, é possível sincronizar até 4.500 usuários.

Para a sincronia de mais de 4.500 usuários, realize mais de uma requisição.

Exemplo de resposta

A resposta de código 201 indica que:

todos os usuários foram criados, atualizados ou excluídos com sucesso e retornará o seguinte JSON:

CODE

[]

ou

houve falha parcial na criação, atualização ou exclusão de alguns usuários, e retornará, em JSON, o motivo da falha:

CODE

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

A resposta de código 400 indica que houve falha na criação, atualização ou exclusão de todos os usuários, e retornará o seguinte JSON:

CODE

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

Chamada

Cabeçalho (header)

Corpo (body)

Exemplo de requisição

Exemplo de resposta