Get public SSH keys

This method retrieves all public SSH keys that are authorized for a specific user.

The user who runs this web service requires the following permission in the Vault:

  • Reset Users' Passwords

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

 

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

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 retrieved.

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

Valid values

Vault user name

Resource information

HTTP method

GET

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

 
{

"GetUserAuthorizedKeysResult":

[

{

"KeyID":"<key-id>",

"PublicSSHKey":"<public-key>"

},

{

"KeyID":"<key-id>",

"PublicSSHKey":"<public-key>"

}

]

}

Return codes

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