Create AD/LDAP
Create LDAP/Active directory for user authentication
- application/json
Request Body
LDAP body request
- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
- directoryType string required
Possible values: [
ACTIVE_DIRECTORY
]Active directory type
- NETBIOSName string required
Domain name (short name) to create LDAP app
- name string required
Domain connect name
- useSecureLDAP boolean
Boolean to indicate if the app use secure LDAP
- enableSSO boolean
Boolean to indicate if the app use enable SSO
- id int32
Required when configuring an existing dummy domain as LDAP/AD
- username string required
Username to create LDAP/AD app
- password base64 required
Password to create LDAP app, it should be base64 encoded
- accessViaClient boolean
Denotes if the domain is accessed via a proxy
proxies object[]
List of proxies used to connect to the domain. Required if accessViaClient is true.
id int32name string- doNotValidateNetBIOSName boolean
If true, the NetBIOS name will not be validated. Providing a custom name without validation may cause problems during Single Sign-On.
- directoryType string required
Possible values: [
APPLE_DIRECTORY_SERVICE
]Apple directory service type
- OSXServerName string required
Domain shortname to create apple directory type app
- name string required
Domain connect name
- id int32
Required when configuring an existing dummy domain as LDAP/AD
- username string required
Username to create LDAP/AD app
- password base64 required
Password to create LDAP app, it should be base64 encoded
- accessViaClient boolean
Denotes if the domain is accessed via a proxy
proxies object[]
List of proxies used to connect to the domain. Required if accessViaClient is true.
id int32name string- doNotValidateNetBIOSName boolean
If true, the NetBIOS name will not be validated. Providing a custom name without validation may cause problems during Single Sign-On.
- directoryType string required
Possible values: [
LDAP_SERVER
]LDAP server directory type - 14
- host string required
Domain shortname
- useSecureLDAP boolean
Boolean to indicate if the app use secure LDAP
LDAPQueryParameters object
Provider attributes for LDAP app
userGroupFilter stringDefault value:
(objectClass=group)
Custom attribute string of LDAP query paramters
userFilter stringDefault value:
(&(objectCategory=User)(sAMAccountName=*))
Custom attribute string of LDAP query paramters
uniqueIdentifier stringDefault value:
sAMAccountName
Custom attribute string of LDAP query paramters
baseDN stringDefault value:
base DN
Custom attribute string of LDAP query paramters
- id int32
Required when configuring an existing dummy domain as LDAP/AD
- username string required
Username to create LDAP/AD app
- password base64 required
Password to create LDAP app, it should be base64 encoded
- accessViaClient boolean
Denotes if the domain is accessed via a proxy
proxies object[]
List of proxies used to connect to the domain. Required if accessViaClient is true.
id int32name string- doNotValidateNetBIOSName boolean
If true, the NetBIOS name will not be validated. Providing a custom name without validation may cause problems during Single Sign-On.
- directoryType string required
Possible values: [
OPEN_LDAP
]Open LDAP directory type
- NETBIOSName string required
Connect name to create open LDAP type app
- name string required
Domain connect name
- id int32
Required when configuring an existing dummy domain as LDAP/AD
- username string required
Username to create LDAP/AD app
- password base64 required
Password to create LDAP app, it should be base64 encoded
- accessViaClient boolean
Denotes if the domain is accessed via a proxy
proxies object[]
List of proxies used to connect to the domain. Required if accessViaClient is true.
id int32name string- doNotValidateNetBIOSName boolean
If true, the NetBIOS name will not be validated. Providing a custom name without validation may cause problems during Single Sign-On.
- directoryType string required
Possible values: [
ORACLE_DIRECTORY
]Oracle directory type
- NETBIOSName string required
Domain shortname
- name string required
Domain connect name
- useSecureLDAP boolean
Boolean to indicate if the app use secure LDAP
- id int32
Required when configuring an existing dummy domain as LDAP/AD
- username string required
Username to create LDAP/AD app
- password base64 required
Password to create LDAP app, it should be base64 encoded
- accessViaClient boolean
Denotes if the domain is accessed via a proxy
proxies object[]
List of proxies used to connect to the domain. Required if accessViaClient is true.
id int32name string- doNotValidateNetBIOSName boolean
If true, the NetBIOS name will not be validated. Providing a custom name without validation may cause problems during Single Sign-On.
- 200
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}
Not Found
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}