---
title: Catalog.Authenticators
slug: ps/help/en_us/vtm/controlapi/catalogauthenticators
docTags: 
createdAt: 2026-08-02T08:52:22.017Z
---

URI: http\://soap.zeus.com/zxtm/1.0/Catalog/Authenticators/

The Catalog.Authenticator interface allows management of authenticator information, which are used by TrafficScript to communicate with an authentication service.

### Methods

### addAuthenticator( class\_names ) throws InvalidObjectName, ObjectAlreadyExists, DeploymentError, LicenseError

Add new Authenticator classes.

```bash
void addAuthenticator(
String[] class_names
)
```

### addLDAPSearchAttr( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add the attributes to return from the search.

```bash
void addLDAPSearchAttr(
String[] names
String[][] values
)
```

### addLDAPSearchAttrByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add the attributes to return from the search. This is a location specific function, any action will operate on the specified location.

```bash
void addLDAPSearchAttrByLocation(
String location
String[] names
String[][] values
)
```

### copyAuthenticator( class\_names, new\_names ) throws ObjectAlreadyExists, InvalidObjectName, ObjectDoesNotExist, DeploymentError, LicenseError

Copy the named Authenticator classes.

```bash
void copyAuthenticator(
String[] class_names
String[] new_names
)
```

### deleteAuthenticator( class\_names ) throws ObjectDoesNotExist, ObjectInUse, DeploymentError, LicenseError

Delete the named Authenticator classes.

```bash
void deleteAuthenticator(
String[] class_names
)
```

### getAuthenticatorNames() throws LicenseError

Get the names of all the configured Authenticator classes.

```bash
String[] getAuthenticatorNames()
```

### getHost( names ) throws ObjectDoesNotExist, LicenseError

Get the hostname of the remote authenticator.

```bash
String[] getHost(
String[] names
)
```

### getHostByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get the hostname of the remote authenticator. This is a location specific function, any action will operate on the specified location.

```bash
String[] getHostByLocation(
String location
String[] names
)
```

### getLDAPBindDN( names ) throws ObjectDoesNotExist, LicenseError

Get the user used to connect to the LDAP server for each of the named Authenticators

```bash
String[] getLDAPBindDN(
String[] names
)
```

### getLDAPBindDNByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get the user used to connect to the LDAP server for each of the named Authenticators This is a location specific function, any action will operate on the specified location.

```bash
String[] getLDAPBindDNByLocation(
String location
String[] names
)
```

### getLDAPFilter( names ) throws ObjectDoesNotExist, LicenseError

Get the filter used to identify user records. Any occurences of '%u' in the filter will be replaced by the name of the user being authenticated.

```bash
String[] getLDAPFilter(
String[] names
)
```

### getLDAPFilterBaseDN( names ) throws ObjectDoesNotExist, LicenseError

Get the DN that we will search for user records under.

```bash
String[] getLDAPFilterBaseDN(
String[] names
)
```

### getLDAPFilterBaseDNByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get the DN that we will search for user records under. This is a location specific function, any action will operate on the specified location.

```bash
String[] getLDAPFilterBaseDNByLocation(
String location
String[] names
)
```

### getLDAPFilterByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get the filter used to identify user records. Any occurences of '%u' in the filter will be replaced by the name of the user being authenticated. This is a location specific function, any action will operate on the specified location.

```bash
String[] getLDAPFilterByLocation(
String location
String[] names
)
```

### getLDAPSSLCertificate( names ) throws ObjectDoesNotExist, LicenseError

Get the SSL certificate in the CA catalog used to authenticate the remote LDAP server.

```bash
String[] getLDAPSSLCertificate(
String[] names
)
```

### getLDAPSSLCertificateByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get the SSL certificate in the CA catalog used to authenticate the remote LDAP server. This is a location specific function, any action will operate on the specified location.

```bash
String[] getLDAPSSLCertificateByLocation(
String location
String[] names
)
```

### getLDAPSSLEnabled( names ) throws ObjectDoesNotExist, LicenseError

Get if SSL should be used to connect to the LDAP server.

```bash
Boolean[] getLDAPSSLEnabled(
String[] names
)
```

### getLDAPSSLEnabledByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get if SSL should be used to connect to the LDAP server. This is a location specific function, any action will operate on the specified location.

```bash
Boolean[] getLDAPSSLEnabledByLocation(
String location
String[] names
)
```

### getLDAPSSLType( names ) throws ObjectDoesNotExist, LicenseError

Get how a SSL connection should be established.

```bash
Catalog.Authenticators.LDAPSSLType[] getLDAPSSLType(
String[] names
)
```

### getLDAPSSLTypeByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get how a SSL connection should be established. This is a location specific function, any action will operate on the specified location.

```bash
Catalog.Authenticators.LDAPSSLType[] getLDAPSSLTypeByLocation(
String location
String[] names
)
```

### getLDAPSearchAttr( names ) throws ObjectDoesNotExist, LicenseError

Get the attributes to return from the search.

```bash
String[][] getLDAPSearchAttr(
String[] names
)
```

### getLDAPSearchAttrByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get the attributes to return from the search. This is a location specific function, any action will operate on the specified location.

```bash
String[][] getLDAPSearchAttrByLocation(
String location
String[] names
)
```

### getNote( names ) throws ObjectDoesNotExist, LicenseError

Get the note for each of the named Authenticators

```bash
String[] getNote(
String[] names
)
```

### getPort( names ) throws ObjectDoesNotExist, LicenseError

Get the port of the remote authenticator.

```bash
Unsigned Integer[] getPort(
String[] names
)
```

### getPortByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get the port of the remote authenticator. This is a location specific function, any action will operate on the specified location.

```bash
Unsigned Integer[] getPortByLocation(
String location
String[] names
)
```

### removeLDAPSearchAttr( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Remove the attributes to return from the search.

```bash
void removeLDAPSearchAttr(
String[] names
String[][] values
)
```

### removeLDAPSearchAttrByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Remove the attributes to return from the search. This is a location specific function, any action will operate on the specified location.

```bash
void removeLDAPSearchAttrByLocation(
String location
String[] names
String[][] values
)
```

### renameAuthenticator( class\_names, new\_names ) throws ObjectAlreadyExists, ObjectDoesNotExist, InvalidObjectName, InvalidOperation, DeploymentError, LicenseError

Rename the named Authenticator classes.

```bash
void renameAuthenticator(
String[] class_names
String[] new_names
)
```

### setHost( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the hostname of the remote authenticator.

```bash
void setHost(
String[] names
String[] values
)
```

### setHostByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the hostname of the remote authenticator. This is a location specific function, any action will operate on the specified location.

```bash
void setHostByLocation(
String location
String[] names
String[] values
)
```

### setLDAPBindDN( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the user used to connect to the LDAP server for each of the named Authenticators

```bash
void setLDAPBindDN(
String[] names
String[] values
)
```

### setLDAPBindDNByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the user used to connect to the LDAP server for each of the named Authenticators This is a location specific function, any action will operate on the specified location.

```bash
void setLDAPBindDNByLocation(
String location
String[] names
String[] values
)
```

### setLDAPBindPassword( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the password of the bind user.

```bash
void setLDAPBindPassword(
String[] names
String[] values
)
```

### setLDAPBindPasswordByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the password of the bind user. This is a location specific function, any action will operate on the specified location.

```bash
void setLDAPBindPasswordByLocation(
String location
String[] names
String[] values
)
```

### setLDAPFilter( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the filter used to identify user records. Any occurences of '%u' in the filter will be replaced by the name of the user being authenticated.

```bash
void setLDAPFilter(
String[] names
String[] values
)
```

### setLDAPFilterBaseDN( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the DN that we will search for user records under.

```bash
void setLDAPFilterBaseDN(
String[] names
String[] values
)
```

### setLDAPFilterBaseDNByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the DN that we will search for user records under. This is a location specific function, any action will operate on the specified location.

```bash
void setLDAPFilterBaseDNByLocation(
String location
String[] names
String[] values
)
```

### setLDAPFilterByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the filter used to identify user records. Any occurences of '%u' in the filter will be replaced by the name of the user being authenticated. This is a location specific function, any action will operate on the specified location.

```bash
void setLDAPFilterByLocation(
String location
String[] names
String[] values
)
```

### setLDAPSSLCertificate( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the SSL certificate in the CA catalog used to authenticate the remote LDAP server.

```bash
void setLDAPSSLCertificate(
String[] names
String[] values
)
```

### setLDAPSSLCertificateByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the SSL certificate in the CA catalog used to authenticate the remote LDAP server. This is a location specific function, any action will operate on the specified location.

```bash
void setLDAPSSLCertificateByLocation(
String location
String[] names
String[] values
)
```

### setLDAPSSLEnabled( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set if SSL should be used to connect to the LDAP server.

```bash
void setLDAPSSLEnabled(
String[] names
Boolean[] values
)
```

### setLDAPSSLEnabledByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set if SSL should be used to connect to the LDAP server. This is a location specific function, any action will operate on the specified location.

```bash
void setLDAPSSLEnabledByLocation(
String location
String[] names
Boolean[] values
)
```

### setLDAPSSLType( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set how a SSL connection should be established.

```bash
void setLDAPSSLType(
String[] names
Catalog.Authenticators.LDAPSSLType[] values
)
```

### setLDAPSSLTypeByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set how a SSL connection should be established. This is a location specific function, any action will operate on the specified location.

```bash
void setLDAPSSLTypeByLocation(
String location
String[] names
Catalog.Authenticators.LDAPSSLType[] values
)
```

### setLDAPSearchAttr( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the attributes to return from the search.

```bash
void setLDAPSearchAttr(
String[] names
String[][] values
)
```

### setLDAPSearchAttrByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the attributes to return from the search. This is a location specific function, any action will operate on the specified location.

```bash
void setLDAPSearchAttrByLocation(
String location
String[] names
String[][] values
)
```

### setNote( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the note for each of the named Authenticators

```bash
void setNote(
String[] names
String[] values
)
```

### setPort( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the port of the remote authenticator.

```bash
void setPort(
String[] names
Unsigned Integer[] values
)
```

### setPortByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the port of the remote authenticator. This is a location specific function, any action will operate on the specified location.

```bash
void setPortByLocation(
String location
String[] names
Unsigned Integer[] values
)
```

### Enumerations

### Catalog.Authenticators.LDAPSSLType

```bash
enum Catalog.Authenticators.LDAPSSLType {
# LDAPS
ldaps,
# Start TLS
starttls
}
```