GetKeyAttributes
This API gets custom attributes of a key.
URL
<http/https>://<host-name>:<Port>/protectappws/services/rest/key/getkeyattributes
Input Parameters
| Parameters | Description |
|---|---|
| userName | User name (optional). |
| password | Password associated with the user (optional). |
| keyName | Name of the key for which custom attributes are to be retrieved. |
| certAlias | Client certificate alias for making SSL connections (optional). |
| certPass | Password for the provided certificate alias (optional). |
Sample REST call for cxf
request
{
"GetKeyAttributes": {
"userName": "test1",
"password": "abcd1234",
"keyName": "123425"
}
}
response
{
"GetKeyAttributesResponse": {
"keyAttributes": "{attr1=123456, attrw=234567}"
}
}
Sample SOAP Parameters
<prot:GetKeyAttributes>
<username>username</username>
<password>abcd1234</password>
<keyName>123425</keyName>
</prot:GetKeyAttributes>
Output
<ns2:GetKeyAttributesResponse xmlns:ns2="http://dsws.org/protectappws/">{attr1=123456, attrw=234567}</ns2:GetKeyAttributesResponse>
Note
The list of attributes that we get in response is comma separated so any attribute (name and value) having special characters (particularly , and {} and “” and =) will be displayed as it is and will make the attribute difficult to read. So, it is recommended NOT to use special characters (particularly , and {} and “” and =) in the input.
