This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Password Properties by Password ID

You can get a list of properties for the specified encryption password.

Request

GET https://<hostname>:4443/v5/EncryptionKeys/{keyId}

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameter must be specified in the URL of the request:

Parameter	Type	Description
keyId	string	Specifies the identification number of the encryption password. For more information on how to get this parameter, see Getting Passwords.

Request Body

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

The response contains the following information:

Property	Type	Description
id	string	Specifies the encryption password ID.
description	string	Specifies the hint of the encryption password.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Examples

Example 1

Request:

GET https://abc.tech.local:4443/v5/EncryptionKeys/28dff50c-cc10-4c36-b8c9-0aa3f27907d2

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

[

{

"id": "28dff50c-cc10-4c36-b8c9-0aa3f27907d2",

"description": "Administrator",

"_links": {"self": {"href": "https://abc.tech.local:4443/v5/encryptionkeys/28dff50c-cc10-4c36-b8c9-0aa3f27907d2"}}

}

]