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

In this article

This section explains how to get a list with properties for the specified encryption password.

Request

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

Request Headers

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

Request Parameters

The following parameters must be posted as URL.

Parameter	Type	Description
keyId	string	An identification number of a cloud account. Can be obtained, as described in Getting Accounts.

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

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

Example

Request:

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

Request Header:

Authorization: Bearer <Access-Token>

Response:

[

{

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

"description": "Administrator",

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

}

]