---
title: DirectoryConfiguration
description: Connection details for directory server(s).
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-directoryconfiguration
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-directoryconfiguration.html
section_ids:
  sec-amster-entity-directoryconfiguration-global-ops: Global Operations
  sec-amster-entity-directoryconfiguration-global-ops-read: read
  sec-amster-entity-directoryconfiguration-global-ops-update: update
---

# DirectoryConfiguration

## Global Operations

Connection details for directory server(s).

Resource path:

```
/global-config/servers/{serverName}/properties/directoryConfiguration
```

Resource version: `1.0`

### read

**Usage**

```
am> read DirectoryConfiguration --global --serverName serverName
```

**Parameters**

* *\--serverName*

  Connection details for directory server(s).

### update

**Usage**

```
am> update DirectoryConfiguration --global --serverName serverName --body body
```

**Parameters**

* *\--serverName*

  Connection details for directory server(s).

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "directoryConfiguration" : {
        "type" : "object",
        "title" : "Directory Configuration",
        "propertyOrder" : 0,
        "properties" : {
          "minConnectionPool" : {
            "title" : "Minimum Connection Pool",
            "propertyOrder" : 0,
            "type" : "number"
          },
          "maxConnectionPool" : {
            "title" : "Maximum Connection Pool",
            "propertyOrder" : 1,
            "type" : "number"
          },
          "bindDn" : {
            "title" : "Bind DN",
            "propertyOrder" : 2,
            "type" : "string"
          },
          "bindPassword" : {
            "title" : "Bind Password",
            "propertyOrder" : 3,
            "type" : "string",
            "format" : "password"
          },
          "mtlsEnabled" : {
            "title" : "mTLS Enabled",
            "description" : "Toggle to enable/disable mTLS",
            "propertyOrder" : 4,
            "type" : "boolean"
          },
          "mtlsAlias" : {
            "title" : "mTLS Certificate Alias",
            "description" : "The alias to use for mTLS. Applicable only when mTLS is enabled",
            "propertyOrder" : 5,
            "type" : "string"
          },
          "mtlsKeyStoreFile" : {
            "title" : "mTLS KeyStore File",
            "description" : "Path to the KeyStore that has the alias. Applicable only when mTLS is enabled",
            "propertyOrder" : 6,
            "type" : "string"
          },
          "mtlsKeyStoreType" : {
            "title" : "mTLS KeyStore Type",
            "description" : "The type of the KeyStore that has the alias. Applicable only when mTLS is enabled",
            "propertyOrder" : 7,
            "type" : "string",
            "enum" : [ "JCEKS", "PKCS12", "BCFKS" ],
            "options" : {
              "enum_titles" : [ "JCEKS", "PKCS12", "BCFKS" ]
            }
          },
          "mtlsKeyStorePasswordFile" : {
            "title" : "mTLS KeyStore Password File",
            "description" : "Path to the password file for the KeyStore. Applicable only when mTLS is enabled",
            "propertyOrder" : 8,
            "type" : "string"
          },
          "mtlsKeyPasswordFile" : {
            "title" : "mTLS Key Password File",
            "description" : "Path to the password file for the Key. Applicable only when mTLS is enabled",
            "propertyOrder" : 9,
            "type" : "string"
          }
        }
      },
      "directoryServers" : {
        "type" : "array",
        "title" : "Server",
        "propertyOrder" : 1,
        "items" : {
          "type" : "object",
          "required" : [ "serverName", "hostName", "portNumber", "connectionType" ],
          "properties" : {
            "serverName" : {
              "title" : "Name",
              "type" : "string",
              "propertyOrder" : 0
            },
            "hostName" : {
              "title" : "Host Name",
              "type" : "string",
              "propertyOrder" : 1
            },
            "portNumber" : {
              "title" : "Port Number",
              "type" : "string",
              "propertyOrder" : 2
            },
            "connectionType" : {
              "type" : "string",
              "enum" : [ "SIMPLE", "SSL" ],
              "options" : {
                "enum_titles" : [ "SIMPLE", "SSL" ]
              },
              "title" : "Connection Type",
              "propertyOrder" : 3
            }
          }
        }
      }
    }
  }
  ```