- URL:https://<config-url>/testIdentityStore
(POST only)
- Required Capability:Default administrator role | Security and Infrastructure | Servers
- Version Introduced:10.1
Description
This operation tests the connection to the input user and role store. If this operation returns an error then the server will not accept the connections and you will need to repair them. The operation will only test the connection without any change to current user and role connections.
Request parameters
Parameter | Details |
---|---|
userStoreConfig | The JSON object representing the user store configuration. |
roleStoreConfig | The JSON object representing the role store configuration. |
f | The response format. The default response format is html. Values: html | json| pjson |
Example usage
Below is a sample POST request for testIdentityStore, formatted for readability:
POST /webadaptor/admin/security/config/testIdentityStore HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
userStoreConfig={
"type": "LDAP",
"properties": {
"userPassword": "secret",
"isPasswordEncrypted": "false",
"user": "uid=admin,ou=system",
"userFullnameAttribute": "displayName",
"userGivenNameAttribute": "givenName",
"userSurnameAttribute": "sn",
"ldapURLForUsers": "ldaps://ldapserver:10636/ou=users,ou=ags,dc=example,dc=com",
"userEmailAttribute": "mail",
"usernameAttribute": "uid",
"caseSensitive": "false",
"userSearchAttribute": "dn",
}
}&roleStoreConfig={
"type": "BUILTIN",
"properties": {}
}&f=json
JSON Response example
{"status": "success"}