username - string - obrigatório - Nome do usuário designado à credencial.hostname - string - obrigatório - Nome do host do dispositivo associado à credencial.ip - string - obrigatório - Endereço IP do dispositivo associado à credencial.content - string - Senha designada à credencial.additional - string - Informações adicionais da credencial.tags - string - Palavras-chave associadas à credencial.credential_type - string - Tipo de credencial.domain - string - Nome de domínio ou abreviação.parent_password - int - ID da credencial pai.type- string - Tipo de dispositivo.vendor - string - Fabricante do dispositivo.model - string - Modelo do dispositivo.site - string - Localização do dispositivo.device_domain - string - Nome de domínio do dispositivo ou abreviação.device_tags - string - Palavras-chave associadas ao dispositivo.connectivities - string - Conectividade do dispositivo.session_remote_config - string - Expressão de login.execution_settings - object - Configurações administrativas da credencial para definição de troca automática de senha e reconciliação da credencial.session_settings - object - Configurações para gerenciamento de privilégios de sessão para aplicativos remotos, protocolos de conectividade, entre outros.additional_settings - object - Configurações para implementação de mecanismos de autenticação da credencial, como TOTP, e designação do usuário dono da credencial, entre outros.jit_settings - object - Configurações para gerenciar o tempo de utilização de serviços.execution_settings - object - Dados das configurações de execução.parent_credential - string - Credencial pai selecionada para a credencial editada.parent_hostname - string - Nome do host da credencial pai selecionada.parent_ip - string - Endereço IP do dispositivo da credencial pai selecionada.automatic_change - boolean - Habilita ou desabilita mudanças automáticas.change_plugin - string - Plugin de mudança para ser usado ao rotacionar a credencial.change_template - string - Template de mudança para ser usado ao rotacionar a credencial.
use_own_credential_to_connect - boolean - Habilita ou desabilita o uso da própria credencial para se conectar ao dispositivo e mudar a credencial. Valor padrão da nova credencial: false
authentication_credential - string - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false) Credencial usada para autenticação durante o processo de rotação da credencial.authentication_hostname - string - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false) - Hostname do dispositivo de autenticação.authentication_ip - string - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false) - Endereço IP do dispositivo de autenticação.status - boolean - Habilita ou desabilita reconciliação de credencial após falha de rotação. Valor padrão da nova credencial: false
reconciliation_credential - string - Credencial a ser usada no processo de reconciliação.reconciliation_hostname - string - Nome do host do dispositivo de reconciliação da credencial.
reconciliation_ip - string - Endereço IP do dispositivo de reconciliação da credencial.reconciliation_plugin - string - Plugin de execução para o processo de reconciliação da credencial.reconciliation_template - string - Template para o processo de reconciliação da credencial. POST {{url}}/api/pam/credential
{
"username": "usernametest",
"hostname": "API-Testing",
"ip": "128.0.0.1",
"execution_settings":
{
"parent_credential": "cred2",
"parent_hostname": "gmail",
"parent_ip": "https://www.gmail.com",
"automatic_change": true,
"change_plugin": "SSH",
"change_template": "3COM",
"use_own_credential_to_connect": false,
"authentication_credential": "cred2",
"authentication_hostname": "gmail",
"authentication_ip": "https://www.gmail.com",
"status": true,
"reconciliation_credential": "cred2",
"reconciliation_hostname": "gmail",
"reconciliation_ip": "https://www.gmail.com",
"reconciliation_plugin": "SSH",
"reconciliation_template": "3COM"
}
}
Configurações implementadas para gerenciar privilégios de sessão em que é possível restringir aplicativos remotos, protocolos de conectividade, entre outros.
Envie os parâmetros abaixo no body da requisição.
session_settings - object - Dados das configurações de sessão.SSH - boolean - Habilita ou desabilita o protocolo SSH. Valor padrão da nova credencial: false
Telnet - boolean - Habilita ou desabilita o protocolo Telnet. Valor padrão da nova credencial: false
MySQL - boolean - Habilita ou desabilita a conexão MySQL. Valor padrão da nova credencial: false
SQL Server - boolean - Habilita ou desabilita a conexão SQL Server. Valor padrão da nova credencial: false
HTTP - boolean - Habilita ou desabilita o protocolo HTTP. Valor padrão da nova credencial: false
HTTPS - boolean - Habilita ou desabilita a conexão HTTPS. Valor padrão da nova credencial: false
RDP - boolean - Habilita ou desabilita a conexão RDP. Valor padrão da nova credencial: false
X11 Forward - boolean - Habilita ou desabilita o X11 Forward. Valor padrão da nova credencial: false
VNC - boolean - Habilita ou desabilita a conexão via VNC. Valor padrão da nova credencial: false
restrict_access_to_remote_application - boolean - Habilita ou desabilita o acesso restrito a sessões proxy RemoteApp. Valor padrão da nova credencial: false
macros - array of objects - Lista dos dados da automação macro contendo remote_app e connectivity.remote_app - string - Automação RemoteApp associada à credencial.connectivity - string - Conectividade para automação RemoteApp associada à credencial.use_own_credential_to_connect - boolean - Habilita ou desabilita o uso da própria credencial para conexão. Valor padrão da nova credencial: false
authentication_credential - string - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false) - A credencial de autenticação.
.authentication_hostname - string - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false) - O nome do host do dispositivo de autenticação.authentication_ip - string - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false) - O endereço IP do dispositivo de autenticação. POST {{url}}/api/pam/credential
{
"username": "usernametest",
"hostname": "API-Testing",
"ip": "128.0.0.1",
"session_settings":
{
"SSH": true,
"Telnet": true,
"MySQL": true,
"SQL Server": true,
"HTTP": true,
"HTTPS": true,
"RDP": true,
"X11 Forward": true,
"VNC": true,
"restrict_access_to_remote_application": true,
"macros":
[
{
"remote_app": "MySQL",
"connectivity": "SSH"
},
{
"remote_app": "Kaspersky",
"connectivity": "RDP"
}
],
"use_own_credential_to_connect": false,
"authentication_credential": "cred2",
"authentication_hostname": "gmail",
"authentication_ip": "https://www.gmail.com"
}
}
Configurações para implementar mecanismos de autenticação da credencial, como TOTP, e designação do usuário dono da credencial, entre outros.
Envie os parâmetros abaixo no body da requisição.
additional_settings - object - Lista com as configurações adicionais da credencialidentifier - string - Identificador da credencial. Usado para recuperar a credencial via Webservice (A2A).user_credential_owner - string - Usuário dono da credencial.server_path - string - Caminho de localização do script ou arquivo onde a credencial está armazenada.secret_key - string - A secret key (TOTP) associada à credencial.criticality - string - O nível de criticidade da credencial. Os valores possíveis são low, medium e high. Valor padrão da nova credencial: medium
additional_authentication_fields - array of objects - Campos adicionais de autenticação. Dados da automação macro contendo name, short_name e value.name - string - Nome da autenticação adicional.short_name - string - Nome curto ou abreviação da autenticação adicional.value - string - O valor a ser preenchido durante o processo de autenticação adicional.notes - string - Observações gerais sobre a credencialCredential to be used only in network A.
POST {{url}}/api/pam/credential
{
"username": "usernametest",
"hostname": "API-Testing",
"ip": "128.0.0.1",
"additional_settings": {
"identifier": "identifer",
"user_credential_owner": "admin",
"server_path": "/etc/host",
"secret_key": "295B3LA1M6LRAHI2S7G1A36LMK6I4IWW",
"criticality": "High",
"additional_authentication_fields": [
{
"name": "name",
"short_name": "short_name1",
"value": "Enable"
},
{
"name": "name2",
"short_name": "short_name2",
"value": "value"
}
]
},
"notes": "Credential to be used only in network A"
}
Configurações JIT (Just-in-Time) são implementadas para gerenciar o tempo de utilização de serviços, especialmente em contextos onde é necessário conceder acesso temporário para a realização de ações específicas. Isso é frequentemente aplicado em situações como criação de contas, ativação de serviços ou adição de permissões temporárias para executar determinadas ações.
As credenciais JIT são empregadas para iniciar sessões em dispositivos localizados em redes segregadas. Essas credenciais são acessíveis via Web Proxy, Terminal Proxy e RDP Proxy, garantindo acesso seguro e temporário aos recursos necessários.
Você pode implementar as configurações JIT ao criar uma credencial para os seguintes cenários:
Envie os parâmetros abaixo no body da requisição.
jit_settings - object - Dados das configurações Just-in-Time para criação e remoção de credencial mediante inicialização e finalização de uma sessão Proxy.jit - boolean - Habilita ou desabilita as configurações Just-in-Time.credential_creation_and_deletion - boolean - Indica a criação da credencial mediante solicitação de inicialização da sessão Proxy, e remoção da credencial após o término da sessão.use_own_credential_to_connect - boolean - Habilita ou desabilita o uso da própria credencial para conectar.authentication_credential - boolean - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false) - A credencial de autenticação.authentication_hostname - boolean - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false) - O nome do host do dispositivo de autenticação.authentication_ip - boolean - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false) - O endereço IP do dispositivo de autenticação.credential_creation_plugin - string - O plugin de criação da credencial.credential_creation_template - string - O template de criação da credencial.credential_deletion_plugin - string - O plugin de remoção da credencial.credential_deletion_template - string - O template de remoção da credencial. POST {{url}}/api/pam/credential
{
"username": "API_CREDENTIAL_3",
"hostname": "API_DEVICE_1",
"ip": "localhost",
"jit_settings": {
"jit": true,
"credential_creation_and_deletion": true,
"enable_disable_credential": false,
"use_own_credential_to_connect": false,
"authentication_credential": "API_CREDENTIAL_1",
"authentication_hostname": "API_DEVICE_1",
"authentication_ip": "localhost",
"credential_creation_plugin": "SSH",
"credential_creation_template": "Linux - Create User",
"credential_deletion_plugin": "SSH",
"credential_deletion_template": "Linux - Remove User"
}
}
Envie os parâmetros abaixo no body da requisição.
jit_settings - object - Dados das configurações Just-in-Time para ativação e desativação de credencial mediante inicialização e finalização de uma sessão Proxy.jit - boolean - Habilita ou desabilita as configurações Just-in-Time.enable_disable_credential - boolean - Habilita a credencial mediante solicitação de inicialização da sessão Proxy, e desativa a credencial após o término da sessão.use_own_credential_to_connect - boolean - Habilita ou desabilita o uso da própria credencial para conectar.authentication_credential - string - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false ) - A credencial de autenticação.authentication_hostname - string - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false ) - O nome do host do dispositivo de autenticação.authentication_ip - string - obrigatório (quando valor do parâmetro use_own_credential_to_connect for false ) - O endereço IP do dispositivo de autenticação.credential_enable_plugin - string - O plugin de habilitação da credencial.credential_enable_template - string - O template de habilitação da credencial.credential_disable_plugin - string - O plugin de desativação da credencial.credential_disable_template - string - O template de desativação da credencial. POST {{url}}/api/pam/credential
{
"username": "API_CREDENTIAL_3",
"hostname": "API_DEVICE_1",
"ip": "localhost",
"jit_settings": {
"jit": true,
"enable_disable_credential": true,
"use_own_credential_to_connect": true,
"authentication_credential": "API_CREDENTIAL_1",
"authentication_hostname": "API_DEVICE_1",
"authentication_ip": "localhost",
"credential_enable_plugin": "LDAP",
"credential_enable_template": "AD - Activate User",
"credential_disable_plugin": "LDAP",
"credential_disable_template": "AD - Deactivate User"
}
}
Possível causa: o parâmetro obrigatório hostname do dispositivo não foi informado.
hostname do dispositivo e envie a requisição novamente.
Possível causa: o parâmetro obrigatório ip do dispositivo não foi informado.
ip do dispositivo e envie a requisição novamente.
Possível causa: o dispositivo não foi encontrado.
Mensagem: "1029: It is not possible to enter a domain that has not been previously registered"
Possível causa: o device_domain não existe ou a formatação enviada está incorreta.
device_domain ou, caso esteja enviando mais de um device_domain, lembre-se de não adicionar espaço entre as vírgulas. Exemplo: qakm.lab.mt4.dev,my_device_domain
Mensagem: "1042: Invalid username"
Possível causa: o parâmetro obrigatório username não foi enviado.
username e envie a requisição novamente. Não é necessário preencher com um valor, mas é necessário enviar o parâmetro.
Mensagem: "1046: Plugin not informed"
Possível causa: o plugin não foi informado.
Mensagem: "1047: Template plugin not informed"
Possível causa: o template não foi informado.
Mensagem: "1053: O identificador só pode conter letras, números, \ "_ \ “ e \”- \” . “
Possível causa: algum caractere proibido foi utilizado na atualização do identifier.
Possível causa: o erro está no servidor Segura®.
Solução: contate o time de suporte para mais informações.
Possível causa: falha na autenticação da sua aplicação com o servidor Segura®.
Solução: verifique os parâmetros de autenticação como Access Token URL, Client ID e Client secret e solicite um novo token de acesso.
Possível causa: falha no reconhecimento da URL da aplicação cliente. Solução: verifique a URL da aplicação cliente e envie a requisição novamente.
Possível causa: ausência do header de autorização na requisição de API.
Solução: solicite um novo token de acesso.
Possível causa: o tempo da requisição se esgotou.
Solução: verifique a conectividade entre a origem da requisição e o servidor Segura®.