v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB

Usuário

Detalhar Usuários

Obtém um usuário específico registrado na Gupy.

get/users/{id}/

Path parameters

idinteger required

ID do usuário

Query parameters

secretstring required

Secret da empresa

Response

Detalha Usuário

idinteger

Identificador do usuário

metadataobject

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

is_pre_registrationboolean

Quando 'true' indica que esse usuário é um pré-registro, quando 'false' o usuário realizou seu primeiro login e definiu sua senha

mobile_internet_allowedboolean

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

times_allowedobject

Grade de horários permitidos para o uso no aplicativo - quando 'null' não há restrições

created_atstring date-time

Data/hora de criação do usuário

created_at_i18nstring

Data/hora de criação do usuário em formato local

blockedboolean

Quando 'true' esse usuário não pode acessar o conteúdo da Gupy

namestring

Nome do usuário

shrot_namestring

Nome abreviado do usuário

ninstring

National Identification Number (CPF para usuários brasileiros)

emailstring

E-mail do usuário

id_numbestring

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

birth_datestring date-time

Data de nascimento do usuário no formato YYYY-MM-DD

birth_date_i18nstring

Data de nascimento do usuário em formato local