Criação de usuário

Esta funcionalidade permite que um usuário administrador crie um novo usuário no sistema NDD Frete. A criação de usuários é fundamental para o gerenciamento centralizado e a atribuição de permissões e acessos.

Autenticação
Para acessar este endpoint, é necessário que o usuário esteja autenticado. A autenticação é feita através de um token JWT, que deve ser enviado no cabeçalho da requisição.
Como utilizar o Postman para fazer a autenticação do identity?

Endpoint
Base URL: A base URL varia conforme o cliente.
Path do Endpoint: /shipper-api/api/UsersExternalProvider/CreateUser
Método HTTP: POST

Dados da Requisição
O corpo da requisição deve conter os seguintes dados para criar um novo usuário:

fullName: Nome completo do usuário
userName: Nome de usuário
userEmail: Email do usuário (deve ser válido e único)
carrierIds: Lista de IDs dos transportadores aos quais o usuário terá acesso
branchIds: Lista de IDs das filiais às quais o usuário terá acesso
startPeriod: Data e hora de início do período de validade do usuário
endPeriod: Data e hora de fim do período de validade do usuário
policies: Lista de IDs dos grupos de permissões atribuídos ao usuário
groupsPolicies: Lista de IDs dos grupos de políticas atribuídos ao usuário
canSeeCanceled: Permissão para visualizar embarques cancelados (true ou false)
canSeeInitiated: Permissão para visualizar embarques iniciados (true ou false)
canSeePlanned: Permissão para visualizar embarques planejados (true ou false)
canSeeShipped: Permissão para visualizar embarques embarcados (true ou false)

Exemplo de Requisição
Você pode usar ferramentas como o Postman para enviar a requisição. Veja um exemplo do corpo da requisição:

Modelo do Corpo de requisição de criação de usuário(JSON):

CODE

{
"fullName": "NomeCompletoExemplo",
"userName": "UserNameExemplo",
"userEmail": "exemplo11@ndd.tech",
"carrierIds": ["52049280-d599-e911-80d2-00155d96372d",
"2761a89a-d599-e911-80d2-00155d96372d",
"a65fb8ab-d599-e911-80d2-00155d96372d"],
"branchIds": ["c2cea1f3-d84e-e811-80d5-00155dfca711",
"acf580a5-f997-4dd9-8637-3f348416e9eb"],
"startPeriod": "2024-08-01T03:00:00.906Z",
"endPeriod": "2024-08-07T03:00:00.000Z",
"policies": ["dc1c578f-3f5e-49f9-5b66-08d956bfc56e",
"c2cea1f3-d84e-e811-80d5-00155dfca711",
"52049280-d599-e911-80d2-00155d96372d"],
"groupsPolicies": ["7925112e-f8b2-412b-26ba-08dcb70f46ba"],
"canSeeCanceled": true,
"canSeeInitiated": true,
"canSeePlanned": true,
"canSeeShipped": true
}

Resposta de Sucesso

Se a criação do usuário for bem-sucedida, a resposta será no formato:

O ID do usuário criado é retornado no campo "data".

Respostas de Falha

Se o e-mail fornecido já estiver em uso, a resposta de erro será:

Caso tente criar um usuário sem informar os IDs de "groupsPolicies" e "policies", a resposta de erro será: