Credential Stores offer a way to store user credentials (for example, passwords, private keys, certificates) and use them to login to the target server, without the user having access to the credentials. That way, the users only have to perform gateway authentication on SPS with their usual password (or to an LDAP database), and if the user is allowed to access the target server, SPS automatically logs in using the Credential Store.
URL
GET https://<IP-address-of-SPS>/api/configuration/policies/credentialstores
Cookies
| Cookie name | Description | Required | Values |
|---|---|---|---|
| session_id | Contains the authentication token of the user | Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API. NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format). |
Sample request
The following command lists the credential stores.
curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/policies/credentialstores
The following command retrieves the properties of a specific credential store.
curl --cookie cookies.txt https://<IP-address-of-SPS>/api/policies/credentialstores/<policy-id>
Response
The following is a sample response received when listing credential stores.
For more information on the meta object, see Message format.
{
"items": [
{
"key": "1580973975727acedd51b2",
"meta": {
"href": "/api/configuration/policies/credentialstores/1580973975727acedd51b2"
}
},
{
"key": "935272738572bc2ec1dbdd",
"meta": {
"href": "/api/configuration/policies/credentialstores/935272738572bc2ec1dbdd"
}
}
],
"meta": {
"first": "/api/configuration/policies/audit_policies",
"href": "/api/configuration/policies/credentialstores",
"last": "/api/configuration/policies/usermapping_policies",
"next": "/api/configuration/policies/indexing",
"parent": "/api/configuration/policies",
"previous": "/api/configuration/policies/content_policies",
"transaction": "/api/transaction"
}
}
When retrieving the endpoint of a specific credential store, the response is the following.
{
"body": {
"name": "API_LOCAL",
"type": {
"authenticator_name": "auth_server_name",
"default_namespace": "{HOST}",
"dns_servers": {
"primary": "192.168.56.1",
"secondary": "192.168.56.2"
},
"domain_mappings": [
{
"domain": "domain",
"host": {
"selection": "fqdn",
"value": "host"
}
}
],
"login_mode": {
"password": {
"key": "e0ecbe98-bd17-4805-ba5d-17fb789f3971",
"meta": {
"href": "/api/configuration/passwords/e0ecbe98-bd17-4805-ba5d-17fb789f3971"
}
},
"selection": "fixed",
"username": "fixed_username"
},
"proxy_server": "http://192.168.56.201:9999",
"selection": "local",
"server_certificate_check": {
"enabled": true,
"trusted_ca": {
"key": "12269547065727ad6e79d9e",
"meta": {
"href": "/api/configuration/policies/trusted_ca_lists/12269547065727ad6e79d9e"
}
}
},
"web_interface_url": "http://erpm_address"
}
},
"key": "935272738572bc2ec1dbdd",
"meta": {
"first": "/api/configuration/policies/credentialstores/1580973975727acedd51b2",
"href": "/api/configuration/policies/credentialstores/935272738572bc2ec1dbdd",
"last": "/api/configuration/policies/credentialstores/935272738572bc2ec1dbdd",
"next": null,
"parent": "/api/configuration/policies/credentialstores",
"previous": "/api/configuration/policies/credentialstores/1580973975727acedd51b2",
"transaction": "/api/transaction"
}
}| Element | Type | Description | ||
|---|---|---|---|---|
| key | string | Top level element, contains the ID of the credential store. | ||
| body | Top level element (string) | The configuration elements of the credential store. | ||
| name | string | The name of the credential store. This name is also displayed on the SPS web interface. It cannot contain whitespace. | ||
| type | Top level item | All elements for the configured type of credential store. | ||
| authenticator_name | string | If your ERPM setup is configured to use an external authentication method, enter the name of the Authentication Server (Authenticator Source) set on your ERPM server. If empty, SPS uses the [Explicit] authenticator. | ||
| default_namespace | string | The default namespace of the accounts (for example, [Linux], [LDAP], [IPMI], W2003DOMAIN). | ||
| dns_servers | Top level item | The IP addresses of the DNS servers to use for resolving the hostnames provided in domain_mappings. | ||
| domain_mappings | Top level list |
Use for RDP connections only. In a domainless environment, use default_namespace. | ||
| encryption | Top level item | Configures the encryption key for the local credential store. | ||
| login_mode | Top level item | Configures the account SPS uses to login to the ERPM server. | ||
| plugin | string |
Must be used if the selection element is set to external_plugin. References the Credential Store plugin. You can find the list of available plugins at the /api/configuration/plugins/credentialstore/ endpoint. To modify or add a plugin, use the value of the returned key as the value of the plugin element, and remove any child elements (including the key). Plugins can only be uploaded using the web interface of SPS. | ||
| proxy_server | string | The IP address and port of the proxy server. Use the http:// or https:// prefix. | ||
| selection | string |
Configures the type of the credential store. Possible values are:
| ||
| server_certificate_chec | Top level item | To verify the certificate of the ERPM server, configure server_certificate_check. | ||
| web_interface_url | string | Name of the DN of the ERPM server. Use the http:// or https:// prefix. | ||
| Elements of dns_servers | Type | Description |
|---|---|---|
| primary | string | The IP address of the primary DNS server. |
| secondary | string | The IP address of the secondary DNS server. |
| Elements of domain_mappings | Type | Description | |
|---|---|---|---|
| domain | string | The domain name used for Domain/Host mapping. | |
| host | Top level item | The host name or address of the domain controller used for Domain/Host mapping. | |
| selection | string |
Declares if the value element contains an IP or an FQDN. Possible values are:
| |
| value | string | The IP address or hostname of the domain controller. | |
| Elements of encryption | Type | Description |
|---|---|---|
| selection | string |
Defines the encryption of the local credential store. Possible values are:
|
| Elements of login_mode | Type | Description |
|---|---|---|
| password | string |
Must be used if the selection element is set to fixed_username. References the password SPS uses to authenticate on the ERPM server. You can configure passwords at the /api/configuration/passwords/ endpoint. To modify or add a password, use the value of the returned key as the value of the password element, and remove any child elements (including the key). |
| selection | string |
Possible values are:
|
| username | string |
Must be used if the selection element is set to fixed_username. The username SPS uses to authenticate on the ERPM server. |
| Elements of server_certificate_check | Type | Description |
|---|---|---|
| enabled | boolean | Set to true to verify the ERPM server's certificate. |
| trusted_ca | string |
Must be used if server certificate checking is enabled. References the list of trusted Certificate Authorities. You configure trusted CAs at the /api/configuration/policies/trusted_ca_lists/ endpoint. To reference a trusted CA list, use the value of the returned key as the value of the trusted_ca element, and remove any child elements (including the key). |
Example:
NOTE: The following example is response only. Credential stores can only be configured using the web interface of SPS.
Use a credential store plugin.
{
"name": "API_PLUGIN",
"type": {
"plugin": {
"key": "2534221015734bb18aaf32",
"meta": {
"href": "/api/configuration/plugins/credentialstore/2534221015734bb18aaf32"
}
},
"selection": "external_plugin"
}
}Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| Code | Description | Notes |
|---|---|---|
| 401 | Unauthenticated | The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 403 | Unauthorized | The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 404 | NotFound | The requested object does not exist. |
