Criação, ativação e bloqueio de login

Permite criar, habilitar ou não a autenticação de usuários.

Este recurso permite:

  • Ativar/Criar um usuário;

  • Desativar a autenticação;

  • Disponibilizar um link de acesso autenticado a Trakto.

Requisitos para uso do recurso

Para utilizar este recurso, é necessário:

Ativar ou desativar o usuário

POST https://api.trakto.io/auth/webhook

Headers

Name
Type
Description

Authorization

string

Bearer <access_token>

Request Body

Name
Type
Description

approved_terms_use

boolean

Determina se, durante o primeiro acesso, o usuário deverá aprovar os termos de uso da plataforma . Utilize o valor "false" quando for necessária a aprovação.

force_reset_password

boolean

Determina se, durante o primeiro acesso, o usuário necessita realizar a definição de uma senha. Determine o valor "true" caso o usuário necessite redefinir a senha.

secret_key

string

Chave secreta e única de integração

action

string

Define se o usuário será ativado/reativado ou desativado na plataforma. Os valores disponíveis para uso são: "activate" e "deactivate".

activation_email

string

Email da conta do usuário para ativação ou desativação.

Valores disponíveis para o atributo "action"

Ação

Definição

activate

Determina a ativação de uma conta dentro da plataforma da Trakto.

Caso o usuário não exista na plataforma, será criada automaticamente

uma nova conta na plataforma

deactivate

Impossibilita e bloqueia o login do usuário.

Descrição da resposta retornada

Atributo

Descrição

Tipo

id

Identificador único do usuário

string

products

Identificadores únicos a qual o usuário pertence. Geralmente definido com ID das versões whitelabel da plataforma

array<string>

email

Email de login do usuário

string

force_reset_password

Identifica se o usuário deverá redefinir a senha durante o primeiro acesso a plataforma

boolean

can_authenticate

Define se o usuário pode autenticar-se no produto, ou seja, ou se está com acesso bloqueado a plataforma

boolean

approved_terms_use

Identifica se é necessário o usuário realizar a aprovação dos termos de uso da plataforma durante o primeiro acesso

boolean

redirect_url

Link que pode ser utilizado para redirecionar o usuário para a dashboard Trakto. O link permite com que o usuário já tenha acesso autenticado na plataforma

string

Last updated

Was this helpful?