Test Identity Store

URL:
https://<root>/security/config/testIdentityStore
Methods:
POST
Required Capability:
Access allowed with either the "Security and Infrastructure" or "Servers" privileges
Version Introduced:
10.1

Description

The testIdentityStore 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

ParameterDetails

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

The following is a sample POST request for the testIdentityStore operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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=pjson

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.