Step 3: Create the LDAP Gateway

POST {{apiPath}}/environments/{{envID}}/gateways

The POST {{apiPath}}/environments/{{envID}}/gateways operation adds a new LDAP gateway resource to the specified environment.

Headers

Authorization Bearer {{accessToken}}

Content-Type application/json

Body

raw ( application/json )

{
    "name": "LDAP Gateway",
    "description": "LDAP gateway",
    "type": "LDAP",
    "enabled": true,
    "vendor": "PingDirectory",
    "serversHostAndPort": [
        "host1:389",
        "host.domain.com:389",
        "10.10.10.10:636",
        "2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"
    ],
    "bindDN": "cn=svc-account",
    "bindPassword": "{{bindPassword}}",
    "searchBaseDN": "o=example",
    "userCorrelationFilterPattern": "(|(uid=$username$)(mail=$username$))",
    "userTypes": [
        {
            "id": "{{userTypeID}}",
            "name": "typeName",
            "passwordAuthority": "LDAP",
            "searchBaseDn": "dc=example,dc=com",
            "orderedCorrelationAttributes": [
                "externalid",
                "uid",
                "username"
            ],
            "allowPasswordChanges": false,
            "newUserLookup": {
                "ldapFilterPattern": "(|(uid=${identifier})(mail=${identifier}))",
                "population": {
                    "id": "{{popID}}"
                },
                "attributeMappings": [
                    {
                        "name": "username",
                        "value": "${ldapAttributes.uid}"
                    }
                ]
            }
        }
    ]
}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/gateways' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "name": "LDAP Gateway",
    "description": "LDAP gateway",
    "type": "LDAP",
    "enabled": true,
    "vendor": "PingDirectory",
    "serversHostAndPort": [
        "host1:389",
        "host.domain.com:389",
        "10.10.10.10:636",
        "2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"
    ],
    "bindDN": "cn=svc-account",
    "bindPassword": "{{bindPassword}}",
    "searchBaseDN": "o=example",
    "userCorrelationFilterPattern": "(|(uid=$username$)(mail=$username$))",
    "userTypes": [
        {
            "id": "{{userTypeID}}",
            "name": "typeName",
            "passwordAuthority": "LDAP",
            "searchBaseDn": "dc=example,dc=com",
            "orderedCorrelationAttributes": [
                "externalid",
                "uid",
                "username"
            ],
            "allowPasswordChanges": false,
            "newUserLookup": {
                "ldapFilterPattern": "(|(uid=${identifier})(mail=${identifier}))",
                "population": {
                    "id": "{{popID}}"
                },
                "attributeMappings": [
                    {
                        "name": "username",
                        "value": "${ldapAttributes.uid}"
                    }
                ]
            }
        }
    ]
}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/gateways")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""name"": ""LDAP Gateway""," + "\n" +
@"    ""description"": ""LDAP gateway""," + "\n" +
@"    ""type"": ""LDAP""," + "\n" +
@"    ""enabled"": true," + "\n" +
@"    ""vendor"": ""PingDirectory""," + "\n" +
@"    ""serversHostAndPort"": [" + "\n" +
@"        ""host1:389""," + "\n" +
@"        ""host.domain.com:389""," + "\n" +
@"        ""10.10.10.10:636""," + "\n" +
@"        ""2001:0db8:85a3:0000:0000:8a2e:0370:7334:389""" + "\n" +
@"    ]," + "\n" +
@"    ""bindDN"": ""cn=svc-account""," + "\n" +
@"    ""bindPassword"": ""{{bindPassword}}""," + "\n" +
@"    ""searchBaseDN"": ""o=example""," + "\n" +
@"    ""userCorrelationFilterPattern"": ""(|(uid=$username$)(mail=$username$))""," + "\n" +
@"    ""userTypes"": [" + "\n" +
@"        {" + "\n" +
@"            ""id"": ""{{userTypeID}}""," + "\n" +
@"            ""name"": ""typeName""," + "\n" +
@"            ""passwordAuthority"": ""LDAP""," + "\n" +
@"            ""searchBaseDn"": ""dc=example,dc=com""," + "\n" +
@"            ""orderedCorrelationAttributes"": [" + "\n" +
@"                ""externalid""," + "\n" +
@"                ""uid""," + "\n" +
@"                ""username""" + "\n" +
@"            ]," + "\n" +
@"            ""allowPasswordChanges"": false," + "\n" +
@"            ""newUserLookup"": {" + "\n" +
@"                ""ldapFilterPattern"": ""(|(uid=${identifier})(mail=${identifier}))""," + "\n" +
@"                ""population"": {" + "\n" +
@"                    ""id"": ""{{popID}}""" + "\n" +
@"                }," + "\n" +
@"                ""attributeMappings"": [" + "\n" +
@"                    {" + "\n" +
@"                        ""name"": ""username""," + "\n" +
@"                        ""value"": ""${ldapAttributes.uid}""" + "\n" +
@"                    }" + "\n" +
@"                ]" + "\n" +
@"            }" + "\n" +
@"        }" + "\n" +
@"    ]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/gateways"
  method := "POST"

  payload := strings.NewReader(`{
    "name": "LDAP Gateway",
    "description": "LDAP gateway",
    "type": "LDAP",
    "enabled": true,
    "vendor": "PingDirectory",
    "serversHostAndPort": [
        "host1:389",
        "host.domain.com:389",
        "10.10.10.10:636",
        "2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"
    ],
    "bindDN": "cn=svc-account",
    "bindPassword": "{{bindPassword}}",
    "searchBaseDN": "o=example",
    "userCorrelationFilterPattern": "(|(uid=$username$)(mail=$username$))",
    "userTypes": [
        {
            "id": "{{userTypeID}}",
            "name": "typeName",
            "passwordAuthority": "LDAP",
            "searchBaseDn": "dc=example,dc=com",
            "orderedCorrelationAttributes": [
                "externalid",
                "uid",
                "username"
            ],
            "allowPasswordChanges": false,
            "newUserLookup": {
                "ldapFilterPattern": "(|(uid=${identifier})(mail=${identifier}))",
                "population": {
                    "id": "{{popID}}"
                },
                "attributeMappings": [
                    {
                        "name": "username",
                        "value": "${ldapAttributes.uid}"
                    }
                ]
            }
        }
    ]
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

POST /environments/{{envID}}/gateways HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "name": "LDAP Gateway",
    "description": "LDAP gateway",
    "type": "LDAP",
    "enabled": true,
    "vendor": "PingDirectory",
    "serversHostAndPort": [
        "host1:389",
        "host.domain.com:389",
        "10.10.10.10:636",
        "2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"
    ],
    "bindDN": "cn=svc-account",
    "bindPassword": "{{bindPassword}}",
    "searchBaseDN": "o=example",
    "userCorrelationFilterPattern": "(|(uid=$username$)(mail=$username$))",
    "userTypes": [
        {
            "id": "{{userTypeID}}",
            "name": "typeName",
            "passwordAuthority": "LDAP",
            "searchBaseDn": "dc=example,dc=com",
            "orderedCorrelationAttributes": [
                "externalid",
                "uid",
                "username"
            ],
            "allowPasswordChanges": false,
            "newUserLookup": {
                "ldapFilterPattern": "(|(uid=${identifier})(mail=${identifier}))",
                "population": {
                    "id": "{{popID}}"
                },
                "attributeMappings": [
                    {
                        "name": "username",
                        "value": "${ldapAttributes.uid}"
                    }
                ]
            }
        }
    ]
}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"name\": \"LDAP Gateway\",\n    \"description\": \"LDAP gateway\",\n    \"type\": \"LDAP\",\n    \"enabled\": true,\n    \"vendor\": \"PingDirectory\",\n    \"serversHostAndPort\": [\n        \"host1:389\",\n        \"host.domain.com:389\",\n        \"10.10.10.10:636\",\n        \"2001:0db8:85a3:0000:0000:8a2e:0370:7334:389\"\n    ],\n    \"bindDN\": \"cn=svc-account\",\n    \"bindPassword\": \"{{bindPassword}}\",\n    \"searchBaseDN\": \"o=example\",\n    \"userCorrelationFilterPattern\": \"(|(uid=$username$)(mail=$username$))\",\n    \"userTypes\": [\n        {\n            \"id\": \"{{userTypeID}}\",\n            \"name\": \"typeName\",\n            \"passwordAuthority\": \"LDAP\",\n            \"searchBaseDn\": \"dc=example,dc=com\",\n            \"orderedCorrelationAttributes\": [\n                \"externalid\",\n                \"uid\",\n                \"username\"\n            ],\n            \"allowPasswordChanges\": false,\n            \"newUserLookup\": {\n                \"ldapFilterPattern\": \"(|(uid=${identifier})(mail=${identifier}))\",\n                \"population\": {\n                    \"id\": \"{{popID}}\"\n                },\n                \"attributeMappings\": [\n                    {\n                        \"name\": \"username\",\n                        \"value\": \"${ldapAttributes.uid}\"\n                    }\n                ]\n            }\n        }\n    ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/gateways")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/gateways",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "LDAP Gateway",
    "description": "LDAP gateway",
    "type": "LDAP",
    "enabled": true,
    "vendor": "PingDirectory",
    "serversHostAndPort": [
      "host1:389",
      "host.domain.com:389",
      "10.10.10.10:636",
      "2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"
    ],
    "bindDN": "cn=svc-account",
    "bindPassword": "{{bindPassword}}",
    "searchBaseDN": "o=example",
    "userCorrelationFilterPattern": "(|(uid=$username$)(mail=$username$))",
    "userTypes": [
      {
        "id": "{{userTypeID}}",
        "name": "typeName",
        "passwordAuthority": "LDAP",
        "searchBaseDn": "dc=example,dc=com",
        "orderedCorrelationAttributes": [
          "externalid",
          "uid",
          "username"
        ],
        "allowPasswordChanges": false,
        "newUserLookup": {
          "ldapFilterPattern": "(|(uid=${identifier})(mail=${identifier}))",
          "population": {
            "id": "{{popID}}"
          },
          "attributeMappings": [
            {
              "name": "username",
              "value": "${ldapAttributes.uid}"
            }
          ]
        }
      }
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/gateways',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "LDAP Gateway",
    "description": "LDAP gateway",
    "type": "LDAP",
    "enabled": true,
    "vendor": "PingDirectory",
    "serversHostAndPort": [
      "host1:389",
      "host.domain.com:389",
      "10.10.10.10:636",
      "2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"
    ],
    "bindDN": "cn=svc-account",
    "bindPassword": "{{bindPassword}}",
    "searchBaseDN": "o=example",
    "userCorrelationFilterPattern": "(|(uid=$username$)(mail=$username$))",
    "userTypes": [
      {
        "id": "{{userTypeID}}",
        "name": "typeName",
        "passwordAuthority": "LDAP",
        "searchBaseDn": "dc=example,dc=com",
        "orderedCorrelationAttributes": [
          "externalid",
          "uid",
          "username"
        ],
        "allowPasswordChanges": false,
        "newUserLookup": {
          "ldapFilterPattern": "(|(uid=${identifier})(mail=${identifier}))",
          "population": {
            "id": "{{popID}}"
          },
          "attributeMappings": [
            {
              "name": "username",
              "value": "${ldapAttributes.uid}"
            }
          ]
        }
      }
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests
import json

url = "{{apiPath}}/environments/{{envID}}/gateways"

payload = json.dumps({
  "name": "LDAP Gateway",
  "description": "LDAP gateway",
  "type": "LDAP",
  "enabled": True,
  "vendor": "PingDirectory",
  "serversHostAndPort": [
    "host1:389",
    "host.domain.com:389",
    "10.10.10.10:636",
    "2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"
  ],
  "bindDN": "cn=svc-account",
  "bindPassword": "{{bindPassword}}",
  "searchBaseDN": "o=example",
  "userCorrelationFilterPattern": "(|(uid=$username$)(mail=$username$))",
  "userTypes": [
    {
      "id": "{{userTypeID}}",
      "name": "typeName",
      "passwordAuthority": "LDAP",
      "searchBaseDn": "dc=example,dc=com",
      "orderedCorrelationAttributes": [
        "externalid",
        "uid",
        "username"
      ],
      "allowPasswordChanges": False,
      "newUserLookup": {
        "ldapFilterPattern": "(|(uid=${identifier})(mail=${identifier}))",
        "population": {
          "id": "{{popID}}"
        },
        "attributeMappings": [
          {
            "name": "username",
            "value": "${ldapAttributes.uid}"
          }
        ]
      }
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/gateways');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "name": "LDAP Gateway",\n    "description": "LDAP gateway",\n    "type": "LDAP",\n    "enabled": true,\n    "vendor": "PingDirectory",\n    "serversHostAndPort": [\n        "host1:389",\n        "host.domain.com:389",\n        "10.10.10.10:636",\n        "2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"\n    ],\n    "bindDN": "cn=svc-account",\n    "bindPassword": "{{bindPassword}}",\n    "searchBaseDN": "o=example",\n    "userCorrelationFilterPattern": "(|(uid=$username$)(mail=$username$))",\n    "userTypes": [\n        {\n            "id": "{{userTypeID}}",\n            "name": "typeName",\n            "passwordAuthority": "LDAP",\n            "searchBaseDn": "dc=example,dc=com",\n            "orderedCorrelationAttributes": [\n                "externalid",\n                "uid",\n                "username"\n            ],\n            "allowPasswordChanges": false,\n            "newUserLookup": {\n                "ldapFilterPattern": "(|(uid=${identifier})(mail=${identifier}))",\n                "population": {\n                    "id": "{{popID}}"\n                },\n                "attributeMappings": [\n                    {\n                        "name": "username",\n                        "value": "${ldapAttributes.uid}"\n                    }\n                ]\n            }\n        }\n    ]\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/gateways")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "name": "LDAP Gateway",
  "description": "LDAP gateway",
  "type": "LDAP",
  "enabled": true,
  "vendor": "PingDirectory",
  "serversHostAndPort": [
    "host1:389",
    "host.domain.com:389",
    "10.10.10.10:636",
    "2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"
  ],
  "bindDN": "cn=svc-account",
  "bindPassword": "{{bindPassword}}",
  "searchBaseDN": "o=example",
  "userCorrelationFilterPattern": "(|(uid=\$username\$)(mail=\$username\$))",
  "userTypes": [
    {
      "id": "{{userTypeID}}",
      "name": "typeName",
      "passwordAuthority": "LDAP",
      "searchBaseDn": "dc=example,dc=com",
      "orderedCorrelationAttributes": [
        "externalid",
        "uid",
        "username"
      ],
      "allowPasswordChanges": false,
      "newUserLookup": {
        "ldapFilterPattern": "(|(uid=\${identifier})(mail=\${identifier}))",
        "population": {
          "id": "{{popID}}"
        },
        "attributeMappings": [
          {
            "name": "username",
            "value": "\${ldapAttributes.uid}"
          }
        ]
      }
    }
  ]
})

response = http.request(request)
puts response.read_body

let parameters = "{\n    \"name\": \"LDAP Gateway\",\n    \"description\": \"LDAP gateway\",\n    \"type\": \"LDAP\",\n    \"enabled\": true,\n    \"vendor\": \"PingDirectory\",\n    \"serversHostAndPort\": [\n        \"host1:389\",\n        \"host.domain.com:389\",\n        \"10.10.10.10:636\",\n        \"2001:0db8:85a3:0000:0000:8a2e:0370:7334:389\"\n    ],\n    \"bindDN\": \"cn=svc-account\",\n    \"bindPassword\": \"{{bindPassword}}\",\n    \"searchBaseDN\": \"o=example\",\n    \"userCorrelationFilterPattern\": \"(|(uid=$username$)(mail=$username$))\",\n    \"userTypes\": [\n        {\n            \"id\": \"{{userTypeID}}\",\n            \"name\": \"typeName\",\n            \"passwordAuthority\": \"LDAP\",\n            \"searchBaseDn\": \"dc=example,dc=com\",\n            \"orderedCorrelationAttributes\": [\n                \"externalid\",\n                \"uid\",\n                \"username\"\n            ],\n            \"allowPasswordChanges\": false,\n            \"newUserLookup\": {\n                \"ldapFilterPattern\": \"(|(uid=${identifier})(mail=${identifier}))\",\n                \"population\": {\n                    \"id\": \"{{popID}}\"\n                },\n                \"attributeMappings\": [\n                    {\n                        \"name\": \"username\",\n                        \"value\": \"${ldapAttributes.uid}\"\n                    }\n                ]\n            }\n        }\n    ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/gateways")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

201 Created

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/gateways/70ed5f1c-09f9-4840-aefa-c22f46affbd0"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "instances": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/gateways/70ed5f1c-09f9-4840-aefa-c22f46affbd0/instances"
        }
    },
    "id": "70ed5f1c-09f9-4840-aefa-c22f46affbd0",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "LDAP Gateway",
    "description": "LDAP gateway",
    "type": "LDAP",
    "enabled": true,
    "supportedVersions": [
        {
            "version": "2.2.21",
            "image": "gcr.io/ping-identity/pingone/pingone-ldap-gateway:2.2.21",
            "recommended": true,
            "latest": true
        },
        {
            "version": "2.2.20",
            "image": "gcr.io/ping-identity/pingone/pingone-ldap-gateway:2.2.20",
            "supportEndsOn": "2023-04-30T00:00:00.000Z",
            "daysUntilSupportEnds": 107
        }
    ],
    "currentAlerts": [
        {
            "category": "No Instances Connected",
            "detail": "No gateway instances are connected. All operations that require access to this gateway will fail.",
            "severity": "ERROR"
        }
    ],
    "bindDN": "cn=svc-account",
    "connectionSecurity": "None",
    "vendor": "PingDirectory",
    "followReferrals": false,
    "userTypes": [
        {
            "id": "03fa5a57-0f08-4c0d-8fa9-4bd54103d9e5",
            "name": "typeName",
            "passwordAuthority": "LDAP",
            "searchBaseDn": "dc=example,dc=com",
            "orderedCorrelationAttributes": [
                "externalid",
                "uid",
                "username"
            ],
            "newUserLookup": {
                "ldapFilterPattern": "(|(uid=${identifier})(mail=${identifier}))",
                "population": {
                    "id": "bdb628f1-5cb3-4819-94ac-2114152e0f63"
                },
                "attributeMappings": [
                    {
                        "name": "username",
                        "value": "${ldapAttributes.uid}"
                    }
                ]
            },
            "allowPasswordChanges": false
        }
    ],
    "validateTlsCertificates": true,
    "serversHostAndPort": [
        "host1:389",
        "host.domain.com:389",
        "10.10.10.10:636",
        "2001:0db8:85a3:0000:0000:8a2e:0370:7334:389"
    ]
}