- 4 minutos de leitura
- Imprimir
- Tema escuroTema claro
- Pdf
POST | Atualizar chave SSH
- 4 minutos de leitura
- Imprimir
- Tema escuroTema claro
- Pdf
Atualize uma chave SSH no PAM Core.
Requisitos
- Autorizaçã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. - Chave SSH criada no PAM Core.
Acesse o documento POST | Criar chave SSH para mais informações.
Requisição
POST
/api/pam/key
Parâmetros de requisição
Envie os parâmetros abaixo no body da requisição.
identifier
- string - obrigatório - String única para identificação da chave SSH.
Nota: valor fornecido pelo usuário ou gerado automaticamente pelo senhasegura em POST | Criar chave SSH e obtido na resposta da requisição de GET | Listar uma chave SSH por [id
].
ip
- string - obrigatório - Endereço IP do dispositivo principal associado à chave SSH.
hostname
- string - obrigatório - Nome do dispositivo principal associado à chave SSH.
private_key
- string - obrigatório - 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 - obrigatório - Chave pública que permite que servidores verifiquem a identidade do usuário associado à chave privada correspondente.Exemplo:
ssh-ed25519 C1lZDI1NTE5AAawZxwAAAAAAC3NzaIIsAET39xdorYcSMZRaB4LG084MD1VvloDSRKRH AzureAD+DeboraLeiteFerreira@HR1SRH3
username
- string - Nome de usuário relacionado à chave no dispositivo.Nota: apesar de não obrigatório, como boa prática, o preenchimento desse campo facilita a busca pela chave SSH.
Valor padrão da nova chave SSH:
usr
enabled
- boolean - Situação da chave SSH: ativa =true
; inativa =false
devices
- array of hostnames - Dispositivos adicionais associados à chave SSH, contendo seuhostname
.
→ hostname
- string - Nome do host do dispositivo adicional.
Nota: apenas dispositivos previamente registrados são aceitos.
tags
- string - Palavras-chave associadas à chave SSH.
key_name
- string - Nome da chave SSH.Nota: apesar de não obrigatório, como boa prática, o preenchimento desse campo facilita a busca pela chave SSH.
password
- string - Senha opcional que fornece uma camada extra de segurança à chave privada.
Exemplo de requisição
POST
{{url}}/api/pam/key
{
"identifier": "sshkey3",
"ip": "10.66.33.120",
"hostname": "w2016",
"private_key": "-----BEGIN OPENSSH PRIVATE KEY-----\r\nTA9Vb5aA0kXaK2HEjGUWgeCBG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW\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",
"username": "dleite3",
"enabled": true,
"devices": [
{
"hostname": "API device test"
}
],
"tags": "mainsshkey",
"key_name": "test4",
"password": "fkjwe87a5a8fa9a"
}
Resposta
{
"code": 201,
"response": {
"status": 201,
"message": "Key updated successfully!",
"error": false,
"error_code": 0,
"detail": "",
"mensagem": "Key updated successfully!",
"erro": false,
"cod_erro": 0
},
"key": {
"id": "83",
"identifier": "sshkey3",
"devices": [
{
"hostname": "API device test",
"ip": "10.66.33.20"
}
],
"devices_error": []
}
}
Erros
400 - Bad Request.
Mensagem: "1004: The device's hostname was not informed"
Possível causa: o parâmetro obrigatório hostname
do dispositivo não foi informado.
hostname
do dispositivo e envie a requisição novamente.Mensagem: "1005: The device's IP was not informed"
Possível causa: o parâmetro obrigatório ip
do dispositivo não foi informado.
ip
do dispositivo e envie a requisição novamente.Mensagem: "1013: The public key was not informed"
Possível causa: o parâmetro obrigatório public_key
não foi informado.
public_key
e envie a requisição novamente.Mensagem: "1014: The private key was not informed"
Possível causa: o parâmetro obrigatório private_key
não foi informado.
private_key
e envie a requisição novamente.Mensagem: "1039: Without PAM Configuration Access permission"
Possível causa: sua autorização não possui permissão de criação de dispositivo.
Solução: solicite ao administrador que revise sua permissão de leitura e escrita aos recursos do PAM Core no A2A.
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 revise 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.