POST SSH/SetUnmatchedKeysetPassPhrase
Assigns an encrypted passphrase for a private key that is missing from 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 |
---|---|
Passphrase | Passphrase to decrypt the key. To specify a password, use your own company password standards or follow the guidelines from the National Institute of Standards and Technology (NIST). |
UnmatchedTrustId |
The TrustID that only contains a public key. To get this value, query the database. For example: SELECT TrustId, PublicKeysCount, PrivateKeysCount FROM [vendbSep2].[dbo].[ssh_trust_cache] where TrustId LIKE 'EncryptedPrivateKey%' AND PublicKeysCount >1 . |
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: Supply a missing passphrase to an orphan keyset
Request
POST https://tpp.venafi.example/vedsdk/SSH/SetUnmatchedKeysetPassPhrase Authorization:Bearer 4MyGeneratedBearerTknz== { "UnmatchedTrustId":"EncryptedPrivateKey-87", "Passphrase":"newPassw0rd!" }
HTTP/1.1 200 OK { "Success":true }