Test Identity Store

URL:: https://<root>/security/config/testIdentityStore
Methods:: POST
Required Capability:: Access allowed with the "Security and Infrastructure" privilege
Version Introduced:: 10.3

Description

The testIdentityStore operation tests the connection to a user or group store.

Request parameters

Parameters Details

Parameters	Details
`userStoreConfig`	Specifies the user store properties. This operations accepts as input all the properties as defined for the Update Identity Store operation. Example Use dark colors for code blocksCopy `1 2 3 4 5 6 userStoreConfig={ "type": "WINDOWS", "properties": { "isPasswordEncrypted": "true" } }`
`groupStoreConfig`	Specifies the group store properties. This operations accepts as input all the properties as defined for the Update Identity Store operation. Example Use dark colors for code blocksCopy `1 2 3 4 5 6 groupStoreConfig={ "type": "WINDOWS", "properties": { "isPasswordEncrypted": "true" } }`
`f`	The response format. The default is `html`. Values: `html` \| `json` \| `pjson`

userStoreConfig

Specifies the user store properties. This operations accepts as input all the properties as defined for the Update Identity Store operation.

Example
Use dark colors for code blocksCopy
userStoreConfig={
  "type": "WINDOWS",
  "properties": {
    "isPasswordEncrypted": "true"
  }
}

groupStoreConfig

Specifies the group store properties. This operations accepts as input all the properties as defined for the Update Identity Store operation.

Example
Use dark colors for code blocksCopy
groupStoreConfig={
  "type": "WINDOWS",
  "properties": {
    "isPasswordEncrypted": "true"
  }
}

f

The response format. The default 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
POST /<context>/portaladmin/security/config/testIdentityStore HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

userStoreConfig={
  "type": "WINDOWS",
  "properties": {
    "userPassword": "secret",
    "isPasswordEncrypted": "false",
    "user": "mydomain\\winaccount",
    "userFullnameAttribute": "displayName",
    "userEmailAttribute": "mail",
    "userGivenNameAttribute": "givenName",
    "userSurnameAttribute": "sn",
    "caseSensitive": "false"
  }
}&groupStoreConfig={
  "type": "WINDOWS",
  "properties": {
    "isPasswordEncrypted": "true"
  }
}&f=pjson

JSON Response example

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