Post
/sys/v1/ldap/test
Test connection using the ldap SSO configuration saved in the account.
Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Body parameters
object
ldap
object Required
name
string Required
icon_url
string Required
ldap_url
string Required
dn_resolution
OneOf
object
object
method
string Required
Valid values[
"construct"
]
domain_format
object Required
property*
string additionalProperties
object
object
method
string Required
Valid values[
"search-by-mail"
]
object
object
method
string Required
Valid values[
"upn"
]
tls
OneOf
object
object
mode
string Required
Valid values[
"disabled"
]
object
object
mode
string Required
Valid values[
"opportunistic"
]
object
object
mode
string Required
Valid values[
"required"
]
validate_hostname
boolean Required
ca
OneOf
CaConfigVariantCaSet
object (CaConfigVariantCaSet)
ca_set
string Required
Valid values[
"global_roots"
]
CaConfigVariantPinned
object (CaConfigVariantPinned)
pinned
Array of string Required
string (byte)
client_key
string (byte)
client_cert
string (byte)
base_dn
string | null
user_object_class
string | null
service_account
object
dn
string Required
password
string Required
authorization
object
valid_for
integer Required
require_role
object | null
property*
string additionalProperties
user_self_provisioning
object
role_assignment
OneOf
object
object
$type
string Required
Valid values[
"Fixed"
]
role
Array Required
OneOf
string
string
Valid values[
"STATEENABLED",
"PENDINGINVITE"
]
string
string
Valid values[
"ACCOUNTADMINISTRATOR",
"ACCOUNTMEMBER",
"ACCOUNTAUDITOR"
]
string (uuid)
string
role_conflict_resolution
string
Valid values[
"backcompat_legacy_roles_only",
"disregard_exclusive_roles"
]
test_credentials
password
string Required
account_role
OneOf
string
string
Valid values[
"ADMIN_USER",
"MEMBER_USER",
"AUDITOR_USER",
"ADMIN_APP",
"CRYPTO_APP"
]
string (uuid)
string
OneOf
object
object
email
string (email) Required
object
object
dn
string Required
Responses
204
Nothing is returned on success