Cadastrar cliente
Realiza o cadastramento de um novo cliente na plataforma.
POST /clients/Body da Requisição
nome
string
Sim
Nome do cliente na plataforma
external_client_code
string
Não
Código customizado do cliente
email_admin
string
Sim
Email do administrador do ambiente
amb_uuid
string
Sim
UUID do ambiente em que o cliente será vinculado
description
string
Não
Informações adicionais do cliente
grupo_seguranca
string
Não
Grupo de segurança do AD que será criado
block_multiple_session
boolean
Não
Ativa/desativa o bloqueio de múltiplas sessões do mesmo usuário
has_license_limit
boolean
Não
Se o cliente possui limite de licenças de acesso
license_limit
number
Não
Número de licenças de acesso
ad_add_aditional_group
string
Não
Grupo de segurança do AD em que o grupo deste cliente deve ser vinculado
in_maintenance
boolean
Não
Ativa/desativa manutenção imediata no cliente
maintenance_msg
string
Não
Mensagem de manutenção imediata
schedule_maintenance
boolean
Sim
Ativa/desativa manutenção programada
schedule_maintenance_start
string
Condicional
Data/hora de início da manutenção programada. Obrigatório quando schedule_maintenance é true
schedule_maintenance_end
string
Condicional
Data/hora de encerramento da manutenção programada. Obrigatório quando schedule_maintenance é true
schedule_maintenance_msg
string
Condicional
Mensagem da manutenção programada. Obrigatório quando schedule_maintenance é true
terminate_sessions
boolean
Não
Encerra sessões ao ativar manutenção programada
schedule_warning
boolean
Sim
Ativa/desativa exibição programada de avisos
schedule_warning_start
string
Condicional
Data/hora de início dos avisos. Obrigatório quando schedule_warning é true
schedule_warning_end
string
Condicional
Data/hora de encerramento dos avisos. Obrigatório quando schedule_warning é true
schedule_warning_msg
string
Condicional
Mensagem do aviso programado. Obrigatório quando schedule_warning é true
display_warning_to_logged_users
boolean
Condicional
Exibe aviso para usuários já logados. Obrigatório quando schedule_warning é true
observations
string
Não
Informações adicionais sobre o cliente
Exemplo de Requisição
Resposta
Status: 200 OK
Retorna o objeto completo do cliente criado, incluindo o cli_uuid gerado.
Atualizado
Isto foi útil?