Raritan PX2/PX3 JSON-RPC API: pdu-json-rpc-api/idl/LdapServerSettings.idl Source File

Raritan PX2/PX3 JSON-RPC API

LdapServerSettings.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3 * Copyright 2010 Raritan Inc. All rights reserved.
4 */
5
6 /** Local and Remote Authentication Management */
7 module auth {
8
9 /** LDAP server interface */
10 module ldapsrv {
11
12 /** LDAP server type */
13 enumeration ServerType {
14 ACTIVE_DIRECTORY, ///< Active directory
15 OPEN_LDAP ///< OpenLDAP
16 };
17
18 /** LDAP server type */
19 enumeration SecurityProtocol {
20 SEC_PROTO_NONE, ///< no security protocol
21 SEC_PROTO_SSL, ///< use SSL
22 SEC_PROTO_STARTTLS ///< use STARTTLS
23 };
24
25 /** Server settings */
26 structure ServerSettings_2_0_0 {
27 string id; ///< Entry ID
28 string server; ///< IP or name of ldap server
29 string adoptSettingsId; ///< Use settings from LDAP server with <ID>
30 ServerType type; ///< Type of LDAP server
31 SecurityProtocol secProto; ///< Security protocol
32 int port; ///< Server port (only for SEC_PROT_NONE and SEC_PROT_STARTTLS)
33 int sslPort; ///< SSL port (only for SEC_PROT_SSL)
34 boolean forceTrustedCert; ///< Enforce trusted certificates
35 boolean allowOffTimeRangeCerts; ///< allow expired and not yet valid certificates
36 string certificate; ///< Certificates
37 string adsDomain; ///< ADS domain
38 boolean useAnonymousBind; ///< use anonymous bind
39 string bindDN; ///< Bind DN
40 string bindPwd; ///< Bind password
41 string searchBaseDN; ///< Base DN for search
42 string loginNameAttr; ///< Login name attribute
43 string userEntryObjClass; ///< User entry object class
44 string userSearchFilter; ///< User search subfilter
45 };
46
47 }
48
49 }
auth::ldapsrv::ServerSettings_2_0_0::bindDN
string bindDN
Bind DN.
Definition: LdapServerSettings.idl:39
auth::ldapsrv::ServerSettings_2_0_0::allowOffTimeRangeCerts
boolean allowOffTimeRangeCerts
allow expired and not yet valid certificates
Definition: LdapServerSettings.idl:35
auth::ldapsrv::ServerSettings_2_0_0::server
string server
IP or name of ldap server.
Definition: LdapServerSettings.idl:28
auth::ldapsrv::ServerSettings_2_0_0::forceTrustedCert
boolean forceTrustedCert
Enforce trusted certificates.
Definition: LdapServerSettings.idl:34
auth::ldapsrv::ServerSettings_2_0_0::certificate
string certificate
Certificates.
Definition: LdapServerSettings.idl:36
auth::ldapsrv::ServerSettings_2_0_0::secProto
SecurityProtocol secProto
Security protocol.
Definition: LdapServerSettings.idl:31
auth
Local and Remote Authentication Management.
Definition: AuthManager.idl:7
auth::ldapsrv::ServerSettings_2_0_0::port
int port
Server port (only for SEC_PROT_NONE and SEC_PROT_STARTTLS)
Definition: LdapServerSettings.idl:32
auth::ldapsrv::ServerSettings_2_0_0
Server settings.
Definition: LdapServerSettings.idl:26
auth::ldapsrv::ServerSettings_2_0_0::searchBaseDN
string searchBaseDN
Base DN for search.
Definition: LdapServerSettings.idl:41
auth::ldapsrv::ACTIVE_DIRECTORY
Active directory.
Definition: LdapServerSettings.idl:14
auth::ldapsrv::ServerSettings_2_0_0::loginNameAttr
string loginNameAttr
Login name attribute.
Definition: LdapServerSettings.idl:42
auth::ldapsrv::ServerSettings_2_0_0::useAnonymousBind
boolean useAnonymousBind
use anonymous bind
Definition: LdapServerSettings.idl:38
auth::ldapsrv::SEC_PROTO_NONE
no security protocol
Definition: LdapServerSettings.idl:20
auth::ldapsrv::OPEN_LDAP
OpenLDAP.
Definition: LdapServerSettings.idl:15
auth::ldapsrv::ServerType
ServerType
LDAP server type.
Definition: LdapServerSettings.idl:13
auth::ldapsrv::ServerSettings_2_0_0::bindPwd
string bindPwd
Bind password.
Definition: LdapServerSettings.idl:40
auth::ldapsrv::SEC_PROTO_SSL
use SSL
Definition: LdapServerSettings.idl:21
auth::ldapsrv::ServerSettings_2_0_0::adoptSettingsId
string adoptSettingsId
Use settings from LDAP server with <ID>
Definition: LdapServerSettings.idl:29
auth::ldapsrv::ServerSettings_2_0_0::userEntryObjClass
string userEntryObjClass
User entry object class.
Definition: LdapServerSettings.idl:43
auth::ldapsrv::ServerSettings_2_0_0::adsDomain
string adsDomain
ADS domain.
Definition: LdapServerSettings.idl:37
auth::ldapsrv::SEC_PROTO_STARTTLS
use STARTTLS
Definition: LdapServerSettings.idl:22
auth::ldapsrv::ServerSettings_2_0_0::sslPort
int sslPort
SSL port (only for SEC_PROT_SSL)
Definition: LdapServerSettings.idl:33
auth::ldapsrv::ServerSettings_2_0_0::userSearchFilter
string userSearchFilter
User search subfilter.
Definition: LdapServerSettings.idl:44
auth::ldapsrv::ServerSettings_2_0_0::id
string id
Entry ID.
Definition: LdapServerSettings.idl:27
auth::ldapsrv::SecurityProtocol
SecurityProtocol
LDAP server type.
Definition: LdapServerSettings.idl:19
auth::ldapsrv::ServerSettings_2_0_0::type
ServerType type
Type of LDAP server.
Definition: LdapServerSettings.idl:30