v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB

Usuário

Cadastrar/Atualizar Usuários

Cadastra ou atualiza usuários em lote em Gupy Treinamento.

post/users/

Query parameters

secretstring required

Secret da empresa

Request body

ninstring

National Identification Number (CPF para usuários brasileiros) - Não pode ser enviado juntamente com email

emailstring

E-mail do usuário - Não pode ser enviado juntamente com nin

namestring required

Nome completo do usuário

id_numberstring

Identity Number (RG para usuários brasileiros), para recuperação de senha em login baseado em CPF, só pode ser enviado juntamente com nin - após ser definido para um usuário ativo não pode ser atualizado

langstring required

Língua do usuário - Útil para o disparo do e-mail de cadastro [pt,es,en]

birth_datestring date

Data de nascimento do usuário no formato 'YYYY-MM-DD' - após ser definido para um usuário ativo não pode ser atualizado

times_allowedobject

Grade de horários permitidos para o uso no aplicativo (pares de horários representando o início e fim do intervalo) - quando 'null' não há restrições

mobile_internet_allowedboolean

Quando 'false' o aplicativo não utilizará internet móvel do dispositivo

metadataobject

Dados extras no formato chave-valor para esse usuário - as chaves habilitadas para cadastro nesse campo precisam ser previamente registradas pelo Admin

groupinteger

Caso seja enviado adiciona o usuário ao grupo de ID especificado

Response

Requisição aceita. Os usuários serão cadastrados ou atualizados de forma assíncrona. A resposta informa a previsão de conclusão do processamento (ends_in / ends_in_i18n).

ends_instring

Previsão de conclusão do processamento

ends_in_i18nstring

Previsão de conclusão do processamento em formato local