Delete public SSH key

This method deletes an authorized public SSH key for a specific user in the Vault, preventing them from authenticating to the Vault via PSM for SSH using a corresponding private SSH key.

The user who runs this web service requires Reset Users' Passwords permission in the Vault.

In addition, the user who runs this web service must be in the same Vault location as or higher than the user whose public SSH keys are deleted.

 

A user cannot manage their own public SSH keys.

URL

 

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %

 

 
https://<IIS_Server_Ip>/PasswordVault/WebServices/PIMServices.svc/Users/{UserName}/AuthenticationMethods/SSHKeyAuthentication/AuthorizedKeys/{KeyID}

The following mandatory value is required in the URL:

Parameter

UserName

Type

String

Description

The name of the user whose public SSH keys will be added.

 
  • This username is not case-sensitive.
  • Specify the name of any user in the Vault.

Valid values

Vault user name

Parameter

KeyID

Type

String

Description

The ID of the public SSH key to delete.

Valid values

The key ID, as returned from the GET method.

Resource information

HTTP method

DELETE

Content type

application/json

Header parameter

Parameter

Authorization

Type

String

Description

The token that identifies the session.

Valid values

A session token that was returned from the “Logon” method.

Body parameters

None

Result

None

Return codes

For a complete list of return codes, see Return Codes.