GET User Store

Retrieves a User Store from the Secure Proxy Configuration Manager.

With the getUserStore/{User Store Name} method, you can retrieve a predefined User Store on the Secure Proxy Configuration Manager.

This API method requires authentication. The authentication token that is generated at login must be passed in through the "X-Authentication" header.

Table 1. GET User Store request details

Get User Store request details.

Method Resource URI Description

GET

User Store

/sspcmrest/sspcm/rest/userStore/getUserStore/{User Store Name}

Get the XML corresponding to the User Store defined with in the Secure Proxy Configuration Manager.

Table 2. GET User Store URI input parameters

Get User Store URI input parameters

Parameter Required or Optional Description Validation Valid values

User Store Name

Required

The name of the User Store that is defined with in Secure Proxy Configuration Manager.

Must be a non-empty string

A-Z a-z 0-9 ._-

Get User Store response body parameters

Table 3. Get User Store response body parameters

GET User Store response body parameters

Parameter Description

XML

The XML corresponding to the User Store.

HTTP User Store request

The following example shows the HTTP request:

GET https://localhost:8443/sspcmrest/sspcm/rest/userStore/getUserStore/userStore2
“X-Authentication”: “61504f4a524b48532b776a3467643733374b526368513d3d”

XML User Store response

The following example shows the XML response.


<userStoreDef>
<description>
<![CDATA[Proxy User Store]]&gt;</description>
<elements>
<userDef>
<description>
<![CDATA[ProxyAdmin]]&gt;</description>
<forceToUnlock>false</forceToUnlock>
<name>proxyAdmin</name>
<properties>
<property>
<name>passwordHistory0</name>
<value>0DPiKuNIrrVmD8IUCuw1hQxNqZc=</value>
</property>
</properties>
<verStamp>1</verStamp>
</userDef>
</elements>
<forceToUnlock>false</forceToUnlock>
<formatVer>1</formatVer>
<lockedBy>admin</lockedBy>
<lockedTimestamp>2014-04-15 03:18:00 PM</lockedTimestamp>
<name>defUserStore</name>
<status>locked</status>
</userStoreDef>