GET KeyStore
Retrieves a keyStore from the Secure Proxy Configuration Manager.
With the getKeyStore/{keyStoreName} method, you can retrieve a predefined keyStore from the Secure Proxy Configuration Manager.
This API method requires authentication, and therefore the authentication token generated at login must be passed in through the "X-Authentication" header.
| Method | Resource | URI | Description |
|---|---|---|---|
GET |
keyStore |
/sspcmrest/sspcm/rest/keyStore/getKeyStore/{keyStoreName} |
Gets the XML corresponding to the keyStore defined with in the Secure Proxy Configuration Manager. |
| Parameter | Required or Optional | Description | Validation | Valid values |
|---|---|---|---|---|
keyStoreName |
Required |
The name of the keyStore that is defined with in the Secure Proxy Configuration Manager. |
Must be a non-empty string |
a-zA-Z0-9_. |
| Parameter | Description |
|---|---|
XML |
The XML corresponding to the keyStore |
HTTP KeyStore request
The following example shows the HTTP request:
GET https://localhost:8443/sspcmrest/sspcm/rest/keyStore/getKeyStore/NM_Trusted
“X-Authentication”: “61504f4a524b48532b776a3467643733374b526368513d3d”
XML KeyStore response
The following example shows the XML response:
<keyStoreDef>
<createdBy>admin</createdBy>
<createdTimestamp>2014-04-15 11:40:09 AM</createdTimestamp>
<description>
<![CDATA[NM_Trusted]]></description>
<elements>
<keyDef>
<enabled>true</enabled>
<forceToUnlock>false</forceToUnlock>
<keyData>
<![CDATA[-----BEGIN CERTIFICATE-----MIIE5DCCAsygAwIBAgICA+gwDQYJKoZIhvc
NAQEFBQAwKzELMAkGA1UEBhMCVVMxDjAMBgNVBAgMBVRleGFzMQwwCgYDVQQDDANJQk0wHh
cNMTMxMTA4MjAzMzIyWhcNMTYwODA0MjAzMzIyWjArMQswCQYDVQQGEwJVUzEOMAwGA1UEC
AwFVGV4YXMxDDAKBgNVBAMMA0lCTTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIB
AIwBNlsgtCfu04Md0/DdvyL+NwlvMy3NLSSRgeO1zm4Fg4fp3+hblqywhqnNpRVeI+IIZok
VPD8rIo3R7JDfgutgPN3Euxsxw0DLnM1cr4sgU9h6EUbp24T7cyfNNoG6I6jiDXMbDUHm/
8EkkPo2AdkG1ddaSZ7l65Pbl9z420yFSkmrvmHQxZmcHnuRNDob5hhs32YfA8DL3Ls9eVB3
y8LXvscZbKprnXHhQl7UGlzqBoPgFOhnQ08jz9AMQivRVPfBGuV++M2cEuqSMYqJW5Ozy4h
fcwVscauVEQUiijtA39nLe2G+FD9YILz+CbFqFzSbBfCCDLuoK6QxFGu1Mm+w+EZuUOPXl6
IlZ0vl16aTv3FCci7Nr6kw1JwACTWMDb+lXipim++w1aKw++Uv6aAH8FFhd97FntQw3VefPb
MfcU0q2CvoNc70wCJiou/h67gyJznBfAdBe6U1gb/x+6hLln7iwVtXoLAsC3/boo1N9qrJj0
+7hdgZwW4F0EOEhoqoUfDqJIiwXTANDWlR3aMDcobuELJth9IeWXvf3DLNFHIxy3NCp0Ef0Q
x573Esynre0Z69KfeiO0bt7o4lWIaCTI7V7iy91iAYue9ihjd2RrjEVHIt1LfwZjdoLvwolD
6F8Y4UTtW/nM9yXoUa7WEliLrqnVCT/+5SIOZ0hiJXAgMBAAGjEjAQMA4GA1UdDwEB/wQEAw
IDuDANBgkqhkiG9w0BAQUFAAOCAgEAXBVn2ehwmd9OHzuYvogroySyc8KTl08DpSXvFdN53t
xDrz/cvYzI4YB2Sf93FBqlWU2K8fj7ioUJcfq2COIJk/pgZiSGA27DphbPrYS7wxIkE65aMD
yUhy4Yl+FYd+97R4cdwHaXSWTIZh737k+Kn0liTk4uUjL4+XwQ1KiXUqPbuMAaCdWwakmqIm
h7aIfe6lZSDYFkF94HaKYOf3kH6oH7kbdTM2Tm7tcuWNU7SMwUnfgYsb6Y3nLoRuiGgOEyGE
u8IZEnM7stsdtpHIJn0c/lk0i4FR+vNRqtdQnC+I7BNJlb+tgZpcVeiSp3cpNTIGqc2/4ar
0YR8uWFtGPIHTM9Wrsz9dEywzRbgs7E/ZQhtvXT4ZwAIZVyYZBMLyEhwbQ0eUuOeik1j8g3S
Qq29wZ+MziGdKSivx+jPVbWSuZHY466f/dCUPAzWE/5PR4Qvtjyh1kySUcVimbo+4WsSxCMw
0TSOUkO0lM3efHZ/Wm0UAX5jognvVnEJ+AftNItxcIuPNRlNk6rxbt6hZs6SLKlwYTR469zP
5ciysJgRICYdltC08prkJPdJ2giQ8go4JW6MgIf+vXURaThPekt0h0qFDFQWdSpax6QfJBuB
D3vx8S/uSJtD1qNpyzTKA9gDXifeA+UX8Ez3Ml7cQRZYmBLb2UdEcgpjyQ+cZ7m8gA=
-----END CERTIFICATE-----]]></keyData>
<keyInHSM>false</keyInHSM>
<keyType>x509Cert</keyType>
<name>MyCert</name>
<serialNum>-24</serialNum>
<validFrom>1383942802000</validFrom>
<validTo>1470342802000</validTo>
<verStamp>0</verStamp>
<versionNum>3</versionNum>
</keyDef>
<keyDef>
<description>
<![CDATA[Marshall Test Description]]></description>
<forceToUnlock>false</forceToUnlock>
<keyData>
<![CDATA[<!-----BEGIN CERTIFICATE-----
MIIE5DCCAsygAwIBAgICA+gwDQYJKoZIhvcNAQEFBQAwKzELMAkGA1UEBhMCVVMx
DjAMBgNVBAgMBVRleGFzMQwwCgYDVQQDDANJQk0wHhcNMTMxMTA4MjAzMzIyWhcN
MTYwODA0MjAzMzIyWjArMQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVGV4YXMxDDAK
BgNVBAMMA0lCTTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAIwBNlsg
tCfu04Md0/DdvyL+NwlvMy3NLSSRgeO1zm4Fg4fp3+hblqywhqnNpRVeI+IIZokV
PD8rIo3R7JDfgutgPN3Euxsxw0DLnM1cr4sgU9h6EUbp24T7cyfNNoG6I6jiDXMb
DUHm/8EkkPo2AdkG1ddaSZ7l65Pbl9z420yFSkmrvmHQxZmcHnuRNDob5hhs32Yf
A8DL3Ls9eVB3y8LXvscZbKprnXHhQl7UGlzqBoPgFOhnQ08jz9AMQivRVPfBGuV+
+M2cEuqSMYqJW5Ozy4hfcwVscauVEQUiijtA39nLe2G+FD9YILz+CbFqFzSbBfCC
DLuoK6QxFGu1Mm+w+EZuUOPXl6IlZ0vl16aTv3FCci7Nr6kw1JwACTWMDb+lXipi
m++w1aKw++Uv6aAH8FFhd97FntQw3VefPbMfcU0q2CvoNc70wCJiou/h67gyJznB
fAdBe6U1gb/x+6hLln7iwVtXoLAsC3/boo1N9qrJj0+7hdgZwW4F0EOEhoqoUfDq
JIiwXTANDWlR3aMDcobuELJth9IeWXvf3DLNFHIxy3NCp0Ef0Qx573Esynre0Z69
KfeiO0bt7o4lWIaCTI7V7iy91iAYue9ihjd2RrjEVHIt1LfwZjdoLvwolD6F8Y4U
TtW/nM9yXoUa7WEliLrqnVCT/+5SIOZ0hiJXAgMBAAGjEjAQMA4GA1UdDwEB/wQE
AwIDuDANBgkqhkiG9w0BAQUFAAOCAgEAXBVn2ehwmd9OHzuYvogroySyc8KTl08D
pSXvFdN53txDrz/cvYzI4YB2Sf93FBqlWU2K8fj7ioUJcfq2COIJk/pgZiSGA27D
phbPrYS7wxIkE65aMDyUhy4Yl+FYd+97R4cdwHaXSWTIZh737k+Kn0liTk4uUjL4
+XwQ1KiXUqPbuMAaCdWwakmqImh7aIfe6lZSDYFkF94HaKYOf3kH6oH7kbdTM2Tm
7tcuWNU7SMwUnfgYsb6Y3nLoRuiGgOEyGEu8IZEnM7stsdtpHIJn0c/lk0i4FR+v
NRqtdQnC+I7BNJlb+tgZpcVeiSp3cpNTIGqc2/4ar0YR8uWFtGPIHTM9Wrsz9dEy
wzRbgs7E/ZQhtvXT4ZwAIZVyYZBMLyEhwbQ0eUuOeik1j8g3SQq29wZ+MziGdKSi
vx+jPVbWSuZHY466f/dCUPAzWE/5PR4Qvtjyh1kySUcVimbo+4WsSxCMw0TSOUkO
0lM3efHZ/Wm0UAX5jognvVnEJ+AftNItxcIuPNRlNk6rxbt6hZs6SLKlwYTR469z
P5ciysJgRICYdltC08prkJPdJ2giQ8go4JW6MgIf+vXURaThPekt0h0qFDFQWdSp
ax6QfJBuBD3vx8S/uSJtD1qNpyzTKA9gDXifeA+UX8Ez3Ml7cQRZYmBLb2UdEcgp
jyQ+cZ7m8gA=
-----END CERTIFICATE-----
>
]]></keyData>
<keyInHSM>false</keyInHSM>
<keyType>x509Cert</keyType>
<name>Marshall Test</name>
<serialNum>0</serialNum>
<validFrom>1383942802000</validFrom>
<validTo>1470342802000</validTo>
<verStamp>0</verStamp>
<versionNum>0</versionNum>
</keyDef>
</elements>
<forceToUnlock>true</forceToUnlock>
<formatVer>10</formatVer>
<lastModifiedBy>admin</lastModifiedBy>
<lastModifiedTimestamp>2014-04-15 11:40:14 AM</lastModifiedTimestamp>
<lockedBy>admin</lockedBy>
<lockedTimestamp>2014-04-15 12:37:23 PM</lockedTimestamp>
<name>NM_Trusted</name>
<status>locked</status>
<type>x509CertStore</type>
<verStamp>5</verStamp>
</keyStoreDef>
<name>NM_Trusted</name>
<status>locked</status>
<type>x509CertStore</type>
<verStamp>5</verStamp>