# Cria um novo usuário Cria um novo usuário. Endpoint: POST /api/v3/users Version: 3.0.0 Security: OAuth2 ## Header parameters: - `CPlug-Company-Id` (number, required) Id da Empresa (Company). Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas. Example: 12 - `Idempotency-Key` (string, required) UUID aleatório gerado por você. Nós utilizamos esse header para evitar duplicidade de registros, ou seja, caso você não tenha recebido a resposta de alguma requisição e mandar o mesmo UUID, nós não duplicaremos o registro. ## Request fields (application/json): - `name` (string) Nome do usuário. Example: "Fulando usuário" - `email` (string) E-mail do usuário. Example: "fulano@email.com" - `password` (string) Senha do usuário. Example: "senha123" - `profile_id` (integer) ID do profile. Example: 123 - `settings` (object) - `settings.notifications` (object) Configurações de notificações. - `settings.notifications.receive_financial_emails` (boolean) Indica se o usuário pode receber e-mails financeiros. Example: true - `settings.notifications.receive_contract_emails` (boolean) Indica se o usuário pode receber e-mails de contratos de planos. - `settings.pos` (object) Configurações do PDV. - `settings.pos.show_in_list_on_open` (boolean) Indica se o usuário pode aparecer na listagem ao abrir o PDV. Example: true - `settings.pos.show_in_sellers_list` (boolean) Indica se o usuário pode aparecer na lista de vendedores do PDV. Example: true - `settings.pos.table_service_password` (string,null) Senha para atendimento de mesa. Atenção: Este campo é proibido quando o campo show_in_sellers_list é false. Example: "123456" - `settings.support` (object) Configurações de suporte. - `settings.support.access_pin` (integer,null) PIN utilizado para dar acesso ao suporte. Example: 12345678 - `companies` (array) Id da Empresa (Company). Por padrão é considerado a empresa informado no header em CPlug-Company-Id. Você pode localizar os IDs das empresas no _endpoint_ de [listagem de empresas](#tag/Companies/operation/get-companies). Example: [1] ## Response 201 fields (application/json): - `id` (integer) ID do usuário. Example: 123 - `name` (string) Nome do usuário. Example: "Fulando usuário" - `username` (string) Nome de usuário do usuário. Example: "fulano" - `email` (string) E-mail do usuário. Example: "fulano@email.com" - `profile` (object) Perfil do usuário. - `profile.id` (integer) Identificador único do perfil. Example: 1 - `profile.name` (string) Nome do perfil. Example: "Administrador" - `profile.description` (string) Descrição do perfil. Example: "Administrador do sistema" - `settings` (object) Configurações do usuário. - `settings.notifications` (object) Configurações de notificações. - `settings.notifications.receive_financial_emails` (boolean) Indica se o usuário pode receber e-mails financeiros. Example: true - `settings.notifications.receive_contract_emails` (boolean) Indica se o usuário pode receber e-mails de contratos de planos. - `settings.pos` (object) Configurações do PDV. - `settings.pos.show_in_list_on_open` (boolean) Indica se o usuário pode aparecer na listagem ao abrir o PDV. Example: true - `settings.pos.show_in_sellers_list` (boolean) Indica se o usuário pode aparecer na lista de vendedores do PDV. Example: true - `companies` (array) Lista de empresas que permite visualizar. - `companies.id` (integer) Identificador único da empresa Example: 1234 - `companies.name` (string) Nome fantasia da empresa. Example: "CPlug" - `companies.company_name` (string,null) Razão social da empresa. Example: "CPlug Tecnologia da Informação" ## Response 400 fields (application/json): - `code` (string, required) Código de erro. Example: "missing_headers" - `message` (string) Descrição do erro. Example: "error message" - `meta` (array) Dados adicionais sobre o erro. ## Response 422 fields (application/json): - `code` (string, required) Código de erro. Example: "uneditable_entity" - `message` (string) Descrição do erro. Example: "description error" - `meta` (array) Dados adicionais sobre o erro. - `meta.field` (string, required) Nome do campo no qual existe um erro de validação. Example: "name" - `meta.validations` (array) - `meta.validations.type` (string, required) Tipo da validação aplicada. Example: "Required" - `meta.validations.value` (array) Tipo de valor aplicável (esse campo pode ser vazio). ## Response 401 fields ## Response 404 fields