POST | Update SSH key

Update an SSH key in PAM Core.

Requirements

• Authorization with access and read and write permission to PAM Core granted by the administator in A2A.
  Access the document on How to create an authorization for an application for more information.
• SSH key created in PAM Core.
  Access the document POST | Create SSH key for more information.

Request

POST /api/pam/key

Request parameters

Send the parameters you want to update in the request body.

• identifier - string - required - Unique string defined by the user or by senhasegura for identifying the credential.

  Note: this value is created by the user or automatically generated by senhasegura in POST | Create SSH key and is obtained in the response to the GET | List an SSH key by id.

• ip - string - required - IP address of the main device associated with the SSH key.

• hostname - string - required - Name of the main device associated with the SSH key.

• private_key - string - required - Private key necessary for user authentication.

  Example: -----BEGIN OPENSSH PRIVATE KEY-----\rcTA9Vb5aA0kXaK2HEjGUWgeCBG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW\rQyNTUxOQAAACCLABE9/nb3BlbnNzaC1rZXktdjEAAAAAxtPOCkR2sGccAAAAKi5DXJnuQ1y\r\nZwAAAAtzc2gtZWQyNTUxOQAAACCLABE9/cTA9VTGVpdGVGZXJyZWlyYUBIUjFTUkb5aA0kXaK2HEjGUWgeCxtPOCkR2sGccA\rDgaNiGsvbkkkXhepU2NQi3iZ4sAET39xMD1VvloDSRdorYc\rSMZRaB4LG084KRHawZxwAAAAI0F6dXJlQUQrRGVib3JhAAAECc20zsB7FuSJQAqhLxe\rgzAQI=\r-----END OPENSSH PRIVATE KEY-----

• public_key - string - required - Public key that allows servers to verify the user's identity associated with the corresponding private key.

  Example: ssh-ed25519 C1lZDI1NTE5AAawZxwAAAAAAC3NzaIIsAET39xdorYcSMZRaB4LG084MD1VvloDSRKRH AzureAD+DeboraLeiteFerreira@HR1SRH3

• username - string - Username related to the key in the device.

  Note: although not required, as good practice, filling out this field helps searching for the SSH key.

  New SSH key default value: usr

• enabled - boolean - SSH key status: active = true; inactive = false

• devices - array of hostnames - Additional devices associated with the SSH key, containing their hostname.

• tags - string - Keywords for identifying the SSH key.

• key_name - string - User-created name for identifying the key.

• password - string - Optional password that provides an extra layer of security to the private key.

  Example request

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

Response

 {
   "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": []
   }
}

Errors