Criar/Atualizar usuários no SoftExpert Administração
Este tutorial tem como objetivo fornecer uma breve demonstração de como criar ou atualizar um usuário no SoftExpert Administração. Não é um guia abrangente sobre integrações, mas sim uma ilustração prática para a criação de uma requisição.
Apresentação
Para que um usuário possa se autenticar no SoftExpert Suite, é necessário que ele esteja cadastrado no SoftExpert Administração, com informações obrigatórias como Login, Matrícula, Nome, Área/Função e Grupo de Acesso.
Neste exemplo, abordaremos o uso do método user para criação ou atualização do usuário, fornecendo apenas os parâmetros obrigatórios necessários para a autenticação.
Este método permite inserir ou editar:
- Dados gerais do usuário;
- Áreas e funções (Identificador e nome);
- Relacionamento entre usuário, Área/Função/Equipe/Grupo de Acesso;
- Relacionamento entre usuário e controlador de domínio.
Se o usuário já existir (com a matrícula previamente cadastrada), as informações
serão atualizadas e substituídas pelas presentes na requisição. Se o valor 1
for inserido no atributo UpdateType
, os atributos do tipo "Lista" serão
substituídos pelos presentes na requisição. Caso nenhum valor ou 0
seja
inserido, os valores serão adicionados aos já cadastrados no sistema.
URL do recurso
POST /apigateway/v1/administration/user
Exemplo
Parâmetros que serão enviados na requisição de exemplo
Esta seção descreve os parâmetros que devem ser enviados em uma requisição de exemplo para criar um usuário no sistema. Os atributos incluem informações como a matrícula do usuário, nome, login, senha, idioma, status de atividade, endereço de e-mail, grupos de acesso, área e função, bem como o tipo de atualização.
A tabela lista cada atributo necessário, seu tipo e descrição, além de especificar se é obrigatório ou não. Um exemplo de solicitação é fornecido em formato JSON, mostrando como os atributos devem ser estruturados e enviados na requisição.
Atributos que serão enviados neste exemplo:
Request Body Parameter | Tipo | Requerido | Descrição |
---|---|---|---|
UserId | String | Sim | Matrícula do usuário. |
UserName | String | Sim | Denominação do usuário. |
UserLogin | String | Sim | Nome utilizado pelo usuário para entrar no sistema |
UserPassword | String | Sim | Senha do usuário. |
UserLanguage | Integer | Não | Informar código para idioma do usuário, conforme coluna "Código no banco de dados" da seção Localização, no documento Requisitos do Sistema |
IsActive | Integer | Não | Usuário habilitado (1 - Habilitado, 0 - Desabilitado). |
IsEnabled | Integer | Não | Usuário bloqueado (1 - Bloqueado, 0 - Desbloqueado). |
UserEmail | String | Sim | Endereço de e-mail do usuário. |
AccGroupIdArray | String | Não | Lista de identificadores de grupo de acesso, separados por vírgula, caso queira se adicionar mais de um. |
DeptPosArray.DeptPos.DepartmentID | String | Não | Identificador da área; |
DeptPosArray.DeptPos.DepartmentName | String | Não | Título da área; |
DeptPosArray.DeptPos.PositionID | String | Não | Identificador da função; |
DeptPosArray.DeptPos.PositionName | String | Não | Título da função; |
UpdateType | Integer | Não | Definição de como as listas de valores dos parâmetros AccGroupIdArray, DeptPosArray e TeamIdArray serão considerados na importação do usuário. |
Exemplo de solicitação:
curl 'https://my-domain.softexpert.com/apigateway/v1/administration/user' \
-H 'Content-Type: application/json' \
-H 'Authorization: <your_api_token>' \
-d '{
"UserId": "jpascal",
"UserName": "João Pascal",
"UserLogin": "jpascal",
"UserPassword": "14UwDX2S9&1u",
"UserLanguage": "1",
"IsActive": 1,
"IsEnabled": 0,
"UserEmail": "jpascal@softexpert.com",
"AccGroupIdArray": "FULL",
"DeptPosArray": {
"DeptPos": {
"DepartmentID": "MKT.D.01",
"DepartmentName": "Marketing Division",
"PositionID": "MKT.P.01",
"PositionName": "Marketing Director"
}
},
"UpdateType": "1"
}' -X POST
Ao realizar o primeiro acesso, o usuário precisará atualizar sua senha. É fundamental que o usuário tenha conhecimento da senha inicial enviada durante a solicitação de cadastro. Essa medida garante a segurança e a integridade das informações do usuário.
Exemplo de resposta:
{
"UserId": "jpascal",
"Status": "Success",
"Detail": "Record successfully added"
}
Considerações Adicionais
- Campos adicionais: Se você deseja incluir campos adicionais no cadastro do usuário, certifique-se de verificar a documentação da API do SoftExpert Administração para conhecer todos os parâmetros disponíveis.
- Validação de senha: Ao criar ou atualizar um usuário, lembre-se de que a senha fornecida deve atender aos requisitos de complexidade estabelecidos pela política de segurança da sua organização.
- Requisitos do sistema: Antes de criar ou atualizar usuários no SoftExpert Suite, certifique-se de que sua instalação atende a todos os requisitos do sistema. Consulte a documentação oficial para obter mais informações.
- Permissões de acesso: O usuário utilizado para cadastro do usuário deve possuir as permissões adequadas para executar ações de criação e atualização de usuários no SoftExpert Suite. Caso contrário, entre em contato com o administrador do sistema.
- Tratamento de erros: Caso ocorra algum erro durante a criação ou atualização do usuário, verifique as mensagens de erro e tente corrigir o problema antes de tentar novamente.