POST SSH/ChangePrivateKeyPassphrase
Changes the private key passphrase for a keyset.
Requirements
- Token scope: SSH:Manage
Headers
-
Content type: Content-Type:application/json.
- Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.
Parameters
Name |
Description |
---|---|
KeyId |
Numeric identifier of the authorized key. To get this information, call GET SSH/KeysetDetails. To find all private keys that require passphrases, call POST SSH/KeysetDetails and ViolationStatus 19. |
Passphrase |
Passphrase that decrypts the key. To specify a passphrase , use your own company password standards or follow the guidelines from the National Institute of Standards and Technology (NIST). |
Returns
Name |
Description |
---|---|
Response |
SshWebResponse object with result of the operation. For more information, see SSH SshWebResponse object. For error information, see SSH web error codes. |
Example: Change the private key passphrase
Request
POST https://tpp.venafi.example/vedsdk/SSH/ChangePrivateKeyPassphrase Authorization:Bearer 4MyGeneratedBearerTknz=={ "KeyId": "191", "Passphrase": "M!yPassw0rd" }
HTTP/1.1 200 OK { "Success":true }