Skip to main content
Skip table of contents

Edição de usuário

Esta funcionalidade permite que um usuário administrador edite os dados de um usuário existente no sistema. A edição pode incluir a atualização de informações pessoais, permissões, filiais, transportadores e períodos de validade.

Autenticação
É 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/EditUser
Método HTTP: PATCH

Corpo da Requisição
O corpo da requisição deve incluir os seguintes campos:

A única diferença do corpo desta requisição para o corpo de criação de um novo usuário é que aqui informamos o ID do usuário que deseja editar.

  • id: ID do usuário a ser editado (obrigató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 associados

  • branchIds: Lista de IDs das filiais associadas

  • startPeriod: Data e hora de início da validade

  • endPeriod: Data e hora de término da validade

  • policies: Lista de IDs das permissões associadas

  • groupsPolicies: Lista de IDs dos grupos de permissões associados

  • canSeeCanceled: Permissão para visualizar embarques cancelados (true/false)

  • canSeeInitiated: Permissão para visualizar embarques iniciados (true/false)

  • canSeePlanned: Permissão para visualizar embarques planejados (true/false)

  • canSeeShipped: Permissão para visualizar embarques embarcados (true/false)

Exemplo de Requisição via POSTMAN:

editar.png

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

CODE
{
"id":"F80E3AF2-1630-4B1A-8F3A-48DF0445129F",
"fullName": "fullnameEDITADO",
"userName":"userNameEDITADO",
"userEmail": "exemplo@ndd.tech",
"carrierIds": ["52049280-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": false,
"canSeeShipped": true
}

Resposta de Sucesso

Se a edição do usuário for bem-sucedida, a resposta retornará neste formato:

image.png

Exemplos de Respostas de Falhas

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

image.png

Se o ID do usuário fornecido não corresponder a nenhum usuário existente, a resposta de erro será:

image.png

{{component-feedback-article}}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.