GET | Listar uma chave SSH por [id]
  • 3 minutos de leitura
  • Tema escuro
    Tema claro
  • Pdf

GET | Listar uma chave SSH por [id]

  • Tema escuro
    Tema claro
  • Pdf

Resumo do artigo

Acesse informações de uma chave SSH registrada no PAM Core.

Requisitos

Requisição

GET /api/pam/key/[id]

Parâmetros de requisição

Envie o parâmetro abaixo no path da URL.

  • id - int - obrigatório - Código único de identificação da chave SSH.
    Nota: Esse valor é automaticamente atribuído pelo senhasegura em POST | Criar chave SSH e é obtido na resposta da requisição GET/api/pam/credential que lista todas as credenciais acessíveis à sua autorização.

    Exemplo de requisição

GET {{url}}/api/pam/key/39

Resposta

HTTP/1.1 200 OK 
{
    "code": 200,
    "response": {
        "status": 200,
        "message": "Key 39",
        "error": false,
        "error_code": 0,
        "detail": "",
        "mensagem": "Key 39",
        "erro": false,
        "cod_erro": 0
    },
    "tenant": "senhasegura",
    "key": {
        "id": "39",
        "username": "dleite",
        "key_name": "test2",
        "hostname": "w2016",
        "ip": "10.66.33.15",
        "private_key": "-----BEGIN OPENSSH PRIVATE KEY-----\r\cTA9Vb5aA0kXaK2HEjGUWgeCBG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW\r\nQyNTUxOQAAACCLABE9/nb3BlbnNzaC1rZXktdjEAAAAAxtPOCkR2sGccAAAAKi5DXJnuQ1y\r\nZwAAAAtzc2gtZWQyNTUxOQAAACCLABE9/cTA9VTGVpdGVGZXJyZWlyYUBIUjFTUkb5aA0kXaK2HEjGUWgeCxtPOCkR2sGccA\r\nDgaNiGsvbkkkXhepU2NQi3iZ4sAET39xMD1VvloDSRdorYc\r\nSMZRaB4LG084KRHawZxwAAAAI0F6dXJlQUQrRGVib3JhAAAECc20zsB7FuSJQAqhLxe\r\ngzAQI=\r\n-----END OPENSSH PRIVATE KEY-----",
        "public_key": "ssh-ed25519 C1lZDI1NTE5AAawZxwAAAAAAC3NzaIIsAET39xdorYcSMZRaB4LG084MD1VvloDSRKRH AzureAD+DeboraLeiteFerreira@HR1SRH3",
        "password": null,
        "devices": [
            {
                "hostname": "API device test",
                "ip": "10.66.33.20"
            }
        ],
        "expiration_time": "2024-06-04T12:20:19"
    }
}

Campos do corpo da resposta

  • key - object - Dados da chave SSH.


    →id - int - Código único de identificação da chave SSH.


    →key_name - string - Nome criado pelo usuário para identificação da chave.


    →hostname - string - Nome do dispositivo principal associado à chave SSH.


    →ip - string - Endereço IP do dispositivo principal associado à chave SSH.


    →private_key - string - Chave privada necessária para autenticação do usuário.    Exemplo: -----BEGIN OPENSSH PRIVATE KEY-----\rcTA9Vb5aA0kXaK2HEjGUWgeCBG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW\rQyNTUxOQAAACCLABE9/nb3BlbnNzaC1rZXktdjEAAAAAxtPOCkR2sGccAAAAKi5DXJnuQ1y\r\nZwAAAAtzc2gtZWQyNTUxOQAAACCLABE9/cTA9VTGVpdGVGZXJyZWlyYUBIUjFTUkb5aA0kXaK2HEjGUWgeCxtPOCkR2sGccA\rDgaNiGsvbkkkXhepU2NQi3iZ4sAET39xMD1VvloDSRdorYc\rSMZRaB4LG084KRHawZxwAAAAI0F6dXJlQUQrRGVib3JhAAAECc20zsB7FuSJQAqhLxe\rgzAQI=\r-----END OPENSSH PRIVATE KEY-----


    →public_key - string - Chave pública que permite que servidores verifiquem a identidade do usuário associado à chave privada correspondente.    Exemplo: ssh-ed25519 C1lZDI1NTE5AAawZxwAAAAAAC3NzaIIsAET39xdorYcSMZRaB4LG084MD1VvloDSRKRH AzureAD+DeboraLeiteFerreira@HR1SRH3


    →password - string - Senha opcional que fornece uma camada extra de segurança à chave privada.


    →tags - string - Palavras-chave para identificação da chave SSH.


    →devices - array de objetos - Dispositivos associados à chave SSH, contendo seu hostname e ip.


          →hostname - string - Nome do host do dispositivo adicional         


          →ip - string - Endereço de IP do dispositivo adicional.


    →expiration_time - string - Tempo de expiração da chave SSH baseado em ISO 8601.    Exemplo: 2024-06-04T12:20:19


Erros

400 - Bad Request

Mensagem: "1015: SSH key not found"

Possível causa: chave SSH não encontrada.

Solução: verifique o id enviado para buscar pela chave SSH e envie a requisição novamente.


Mensagem: "1016: The item is not a ssh key"


Possível causa: o valor do parâmetro id não corresponde a uma chave SSH.

Solução: verifique o id e envie a requisição novamente.


Mensagem: "1017: Key inactive"

Possível causa: A chave SSH está inativa.

Solução: ative a chave através do endpoint PUT api/pam/key/[id], e em envie a requisição de consulta à chave novamente.


404 - Not Found

Mensagem: "resource sub not found"

Possível causa: a URL ou o recurso solicitado não está correto.

Solução: verifique a URL e garanta que todos os parâmetros estão corretos.


500 - Internal Server Error

Mensagem: "Unexpected error."

Possível causa: o erro está no servidor senhasegura.

Solução: contate o time de suporte para mais informações.


Mensagem: "You are not authorized to access this resource."

Possível causa: você não possui autorização para acessar esse recurso.

Solução: solicite ao administrador que verifique sua permissão de acesso aos recursos do PAM Core no A2A.


Client authentication failed

Mensagem: "Client authentication failed."

Possível causa: falha na autenticação da sua aplicação com o servidor senhasegura.

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.


Invalid signature

Mensagem: "Invalid signature"

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.


No route matched with those values

Mensagem: "No route matched with those values."

Possível causa: ausência do header de autorização na requisição de API.

Solução: solicite um novo token de acesso.


Request timed out

Mensagem: "Request timed out."

Possível causa: o tempo da requisição se esgotou.

Solução: verifique a conectividade entre a origem da requisição e o servidor senhasegura.


Este artigo foi útil?