Usuários na API

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

Criando novos usuários

Basta enviar os detalhes do novo usuário.

cURL

curl -X POST 'https://op.digesto.com.br/api/admin/user' \
-H 'Content-Type: application/json' \
-H 'Host: op.digesto.com.br' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'
-d '{
    "email": "joao@gmail.com",
    "name": "Joao da Silva"
}'

Parâmetro	Tipo	Descrição
email	string	Endereço de email do usuário.
name	string	Nome do usuário.

Resposta

{
    "email": "joao@gmail.com",
    "name": "Joao da Silva"
}

Criando novos usuários em empresas filhas

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

cURL

curl -X POST 'https://op.digesto.com.br/api/admin/user/create_user_on_child_company' \
-H 'Content-Type: application/json' \
-H 'Host: op.digesto.com.br' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'
-d '{
    "email": "joao@gmail.com",
    "name": "Joao da Silva",
    "user_company": 12
}'

Parâmetro	Tipo	Descrição
email	string	Endereço de email do usuário.
name	string	Nome do usuário.
user_company	integer	ID da empresa filha.

Resposta

{
    "roles": [],
    "api_key": null,
    "name": "Joao da Silva",
    "$uri": "/api/admin/user/1",
    "archived_at": null,
    "last_login_at": null,
    "user_company_id": 12,
    "email": "joao@gmail.com",
    "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/admin/user_company/12"},
}

Parâmetro	Tipo	Descrição
roles	list	Lista de perfis do usuário.
api_key	string	Chave de API do usuário.
name	string	Nome do usuário.
$uri	string	URI do usuário.
archived_at	datetime	Data de arquivamento do usuário.
last_login_at	datetime	Data do último login do usuário.
user_company_id	integer	ID da empresa filha.
email	string	Endereço de email do usuário.
user_creator_id	integer	ID do criador do usuário.
is_new_password	boolean	Indica se a senha é nova.
last_pw_change_at	datetime	Data da última alteração de senha.
is_autogenerated	boolean	Indica se o usuário foi gerado automaticamente.
email_config_user_id	integer	ID de configuração de email do usuário.
created_at	datetime	Data de criação do usuário.
user_company	object	Referência à empresa filha do usuário.

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.

cURL

curl -X POST 'https://op.digesto.com.br/api/admin/user/5/reset_api_token' \
-H 'Content-Type: application/json' \
-H 'Host: op.digesto.com.br' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Parâmetro	Tipo	Descrição
id	integer	ID do usuário.

Resposta

{
    "$uri": "/api/admin/user/12",
    "api_key": "0bb5e3a5-cd56-46c1-8552-061839f07914",
    "archived_at": null,
    "created_at": {
        "$date": 1509126090000
    },
    "email": "local2@teste.com.br",
    "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/admin/user_company/1"
    },
    "user_company_id": 1,
    "user_creator_id": 3
}

Parâmetro	Tipo	Descrição
$uri	string	URI do usuário.
api_key	string	Chave de API do usuário.
archived_at	datetime	Data de arquivamento do usuário.
created_at	datetime	Data de criação do usuário.
email	string	Endereço de email do usuário.
is_autogenerated	boolean	Indica se o usuário foi gerado automaticamente.
is_new_password	boolean	Indica se a senha é nova.
last_login_at	datetime	Data do último login do usuário.
last_pw_change_at	datetime	Data da última alteração de senha.
name	string	Nome do usuário.
roles	list	Lista de perfis do usuário.
user_company	object	Referência à empresa filha do usuário.
user_company_id	integer	ID da empresa filha.
user_creator_id	integer	ID do criador do usuário.