Step 3: Create the LDAP Gateway

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

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

For property descriptions, see Gateway base data model.

Property	Type	Required?
`credentials`	Object[]	Optional
`description`	String	Optional
`_embedded.instances`	Object[]	Optional
`enabled`	Boolean	Required
`name`	String	Required
`supportedVersions`	Object	Optional
`supportedVersions.version`	String	Optional
`supportedVersions.image`	String	Optional
`supportedVersions.recommended`	Boolean	Optional
`supportedVersions.latest`	Boolean	Optional
`type`	String	Required

For LDAP gateway property descriptions, see Gateway LDAP data model.

Property	Type	Required?
`bindDN`	String	Required
`bindPassword`	String	Required
`connectionSecurity`	String	Optional
`kerberos`	Object	Optional
`kerberos.serviceAccountPassword`	String	Optional
`kerberos.serviceAccountUserPrincipalName`	String	Required
`kerberos.minutesToRetainPreviousCredentials`	Integer	Optional
`serversHostAndPort`	String[]	Required
`userTypes`	Object[]	Required
`userTypes.allowPasswordChanges`	Boolean	Optional
`userTypes.id`	UUID	Required
`userTypes.name`	String	Required
`userTypes.newUserLookup`	Object	Optional
`userTypes.newUserLookup.attributeMappings`	Object[]	Required
`userTypes.newUserLookup.attributeMappings.name`	String	Required
`userTypes.newUserLookup.attributeMappings.value`	Object	Required
`userTypes.newUserLookup.ldapFilterPattern`	String	Optional
`userTypes.newUserLookup.population`	String	Optional
`userTypes.newUserLookup.population.id`	UUID	Optional
`userTypes.orderedCorrelationAttributes`	Object[]	Optional
`userTypes.passwordAuthority`	String	Required
`userTypes.searchBaseDn`	String	Optional
`validateTlsCertificates`	Boolean	Optional
`vendor`	String	Required

Request Body

{"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

Key	Datatype	Required	Description
`Authorization`	string
`Content-Type`	string