Usuários na API

Esta API permite o cadastro de novos usuários para o portal Digesto Operações.

Detalhes de um usuário (/api/user)

Representa um usuário dentro do Digesto Operações.

É representado por um dicionário JSON com os seguintes campos.

api_key
[string,null] Chave para uso da API. Somente-leitura.
created_at
[object,null]
email
[string] [1]
archived_at
[datetime] se foi excluido (nullable=True). Caso entidate tenha sido excluída, este campo tem o valor da datahora da última exclusão. Caso não esteja excluído, o valor é null. Campo somente-leitura.
is_new_password
[boolean,null]
last_login_at
[object,null]
last_pw_change_at
[object,null]
name
[string] [1]
roles
[array strings] perfis de acesso do usuário
user_company
[object] Referência à empresa à qual o pedido pertence. (“UserCompany”). Campo somente-leitura, preenchido automaticamente na criação.
[1](1, 2) Obrigatório na criação de entidades.

Criando novos usuários

POST https://op.digesto.com.br/api/user

Basta enviar os detalhes do novo usuário.

Exemplo de chamada:

POST https://op.digesto.com.br/api/user HTTP/1.1
Content-Type: application/json

{
  "email": "[email protected]",
  "name": "Joao da Silva"
}

Exemplo de resposta:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "email": "[email protected]",
  "name": "Joao da Silva"
}
Request Headers:
 
Response Headers:
 

Criando novos usuários em empresas filhas

POST https://op.digesto.com.br/api/user/create_user_on_child_company

Para criar um usuário nas empresas filhas é necessario estar logado na empresa mãe.

Basta enviar o nome do usuário, email e o id da empresa filha

Exemplo de chamada:

POST https://op.digesto.com.br/api/user/create_user_on_child_company HTTP/1.1
Content-Type: application/json

{
  "email": "[email protected]",
  "name": "Joao da Silva",
  "user_company": 12
}

Exemplo de resposta:

Dados do usuário criado.

HTTP/1.1 200 OK
Content-Type: application/json

     {
         "roles": [],
         "api_key": null,
         "name": "Joao da Silva",
         "$uri": "/api/user/1",
         "archived_at": null,
         "last_login_at": null,
         "user_company_id": 12,
         "email": "[email protected]",
         "user_creator_id": 12345,
         "is_new_password": false,
         "last_pw_change_at": null,
         "is_autogenerated": false,
         "email_config_user_id": 2342,
         "created_at": {"$date": 1585580989000},
         "user_company": {"$ref": "/api/user_company/12"},
     }
Request Headers:
 
Response Headers:
 

Resetar o token de API de um usuário

Na chamada abaixo, use o token de API de um usuário admin da empresa à qual o usuário pertence. Ou então um token API de empresa mãe.

Após a chamada, o token atual do usuario referenciado na URL não será mais válido. O novo token é retornado junto dos detalhes do usuário, no campo api_key.

POST https://op.digesto.com.br/api/user/(int: id)/reset_api_token

Exemplo de chamada:

POST https://op.digesto.com.br/api/user/5/reset_api_token?api_key=<chave> HTTP/1.1
Content-Type: application/json

Exemplo de resposta:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
    "$uri": "/api/user/12",
    "api_key": "0bb5e3a5-cd56-46c1-8552-061839f07914",
    "archived_at": null,
    "created_at": {
        "$date": 1509126090000
    },
    "email": "[email protected]",
    "is_autogenerated": false,
    "is_new_password": false,
    "last_login_at": {
        "$date": 1509126176000
    },
    "last_pw_change_at": null,
    "name": "teste usuario local",
    "roles": [
        "proc.monitorar",
        "companyadmin"
    ],
    "user_company": {
        "$ref": "/api/user_company/1"
    },
    "user_company_id": 1,
    "user_creator_id": 3
}
Request Headers:
 
Response Headers: