POST | Atualizar credencial

Atualize uma credencial no PAM Core.

Requisitos

• Autotrização com permissão de acesso e de leitura e escrita ao PAM Core concedidas pelo administrador no A2A.
  Acesse o documento sobre Como criar uma autorização para uma aplicação para mais informações.
• Credencial criada no PAM Core.
  Acesse o documento POST | Criar credencial para mais informações.

Requisição

POST api/pam/credential

Parâmetros de requisição

Envie os parâmetros que deseja atualizar no body da requisição.

• identifier - string - obrigatório - String única definida pelo usuário ou pelo senhasegura para identificar a credencial.

Nota: esse valor é criado em POST | Criar credencial e é obtido na resposta da requisição GET | Listar todas as credenciais

• username - string - obrigatório - Nome do usuário designado à credencial.

Nota: não é necessário enviar um valor para o parâmetro, mas é necessário inserir o parâmetro.
Valor padrão da nova credencial: usr

• 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.

Valor padrão da nova credencial: -

• additional - string - Informações adicionais da credencial.

Valor padrão da nova credencial: -

• tags - string - Palavras-chave associadas à credencial.

Valor padrão da nova credencial: -

• credential_type - string - Tipo de credencial.

Valor padrão da nova credencial: Local User

• domain - string - Nome de domínio ou abreviação.

Valor padrão da nova credencial: -

• parent_password - int - ID da credencial pai.

Valor padrão da nova credencial: -

• type- string - Tipo de dispositivo.

Nota: um novo tipo é criado caso o valor passado seja único.
Valor padrão da nova credencial: -

• vendor - string - Fabricante do dispositivo.

Nota: um novo fabricante é criado caso o valor passado seja único.
Valor padrão da nova credencial: -

• model - string - Modelo do dispositivo.

Nota: um novo modelo é criado caso o valor passado seja único.
Valor padrão da nova credencial: -

• site - string - Localização do dispositivo.

Nota: um novo site é criado caso o valor passado seja único.
Valor padrão da nova credencial: -

• device_domain - string - Nome de domínio do dispositivo ou abreviação.

Nota: apenas domínios previamente registrados são aceitos.
Valor padrão da nova credencial: -

• device_tags - string - Palavras-chave associadas ao dispositivo.

Valor padrão da nova credencial: -

• connectivities - string - Conectividade do dispositivo.

Valor padrão da nova credencial: -

• session_remote_config - string - Expressão de login.

Valor padrão da nova credencial: -

• execution_settings - object - Configurações administrativas da credencial para definição de troca automática de senha e reconciliação da credencial.

Exemplo: acessar seção Configurações de execução.
Valor padrão da nova credencial: -

• session_settings - object - Configurações para gerenciamento de privilégios de sessão para aplicativos remotos, protocolos de conectividade, entre outros.

Exemplo: acessar seção Configurações de sessão.
Valor padrão da nova credencial: -

• 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.

Exemplo: acessar seção Configurações adicionais.
Valor padrão da nova credencial: -

• jit_settings - object - Configurações para gerenciar o tempo de utilização de serviços.

Exemplo: acessar seção Configurações JIT.
Valor padrão da nova credencial: -

Opções de atualização de credencial

Você pode optar por uma das seguintes opções para atualizar uma credencial no PAM Core:

• Enviando um valor para o parâmetro identifier.
• Enviando um valor para o parâmetro username.

Em ambos os casos, é necessário fornecer valores existentes para os parâmetros hostname e ip do dispositivo associados à credencial.

Enviar o parâmetro identifier

• Envie hostname e ip existentes.
• Envie identifier existente ou novo.

Exemplo de requisição - identifier existente

O exemplo a seguir mostra a atualização de uma credencial com um identifier que já pertence a uma credencial.

POST {{url}}/api/pam/credential

{
    "username" : "username",
    "hostname": "w2016",  
    "ip": "10.66.33.15",
    "content": "#@*MyS@feP@ssword%$#",
    "identifier": "dyaihdppaj78a547",
    "tags": "social"
}

Resposta

{
   "code": 201,
   "response": {
       "status": 201,
       "message": "Credential updated successfully!",
       "error": false,
       "error_code": 0,
       "detail": "",
       "mensagem": "Credential updated successfully!",
       "erro": false,
       "cod_erro": 0
   },
   "tenant": "senhasegura",
   "credential": {
       "id": "152",
       "identifier": "dyaihdppaj78a547"
   }
}

Exemplo de requisição - identifier novo

O exemplo a seguir mostra a atualização de uma credencial com um identifier novo. Nesse caso, a credencial foi localizada porque os valores dos parâmetros hostname, ip e username indicaram a sua existência.

POST {{url}}/api/pam/credential

{
    "username" : "username",
    "hostname": "w2016",  
    "ip": "10.66.33.15",
    "content": "#@*MyS@feP@ssword%$#",
    "identifier": "newidentifier17846aa8",
    "tags": "social"
}

Resposta

{
    "code": 201,
    "response": {
        "status": 201,
        "message": "Credential updated successfully!",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Credential updated successfully!",
        "erro": false,
        "cod_erro": 0
    },
    "tenant": "senhasegura",
    "credential": {
        "id": "152",
        "identifier": "newidentifier17846aa8"
    }
}

Enviar o parâmetrousername

• Envie username, hostname e ip existentes.
• Não envie um valor para o identifier.

Exemplo de requisição - username existente

O exemplo a seguir mostra a atualização de uma credencial com um username que já pertence a uma credencial.

POST {{url}}/api/pam/credential

{
    "username" : "username",
    "hostname": "w2016",  
    "ip": "10.66.33.15",
    "content": "#@*MyS@feP@ssword%$#",
    "identifier": "",
    "tags": "social"
}

Resposta

{
   "code": 201,
   "response": {
       "status": 201,
       "message": "Credential updated successfully!",
       "error": false,
       "error_code": 0,
       "detail": "",
       "mensagem": "Credential updated successfully!",
       "erro": false,
       "cod_erro": 0
   },
   "tenant": "senhasegura",
   "credential": {
       "id": "152",
       "identifier": "018fee1d-bc06-70b0-941b-163724042b60"
   }
}

Outros parâmetros da credencial

Você também pode atualizar outros parâmetros da credencial. São eles:

• Configurações de execução.
• Configurações de sessão.
• Configurações adicionais.
• Configurações JIT.

Configurações de execução

Configurações administrativas da credencial em que é possível definir a troca automática de senha e reconciliação da credencial.

Parâmetros de requisição

Envie os parâmetros que deseja atualizar no body da requisição.

{
    "username": "exemplo caderno 3.32",
    "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,
        "agent_based_password_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"
    }
}

{
    "username": "exemplo caderno 3.32",
    "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"
        }
}

{
    "username": "exemplo caderno 3.32",
    "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"
}

{
  "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"
  }
}

{
  "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"
  }
}