For the complete documentation index, see llms.txt. This page is also available as Markdown.

LDAP Configurations

Get All Configs

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Responses
200

Successful Response

application/json
or
get/api/v1/ldap-configs
GET /api/v1/ldap-configs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Successful Response

[
  {
    "id": 1,
    "host": "text",
    "port": 1,
    "base_dn": "text",
    "admin_cn": "text",
    "ou": "text",
    "auth_type": "text"
  }
]

Create Ldap Config

post
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body
hoststringRequired
portintegerOptionalDefault: 389
base_dnstringRequired
admin_cnstringRequired
admin_passwordstringRequired
oustringRequired
auth_typestringRequired
Responses
200

Successful Response

application/json
or
post/api/v1/ldap-configs
POST /api/v1/ldap-configs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "host": "text",
  "port": 389,
  "base_dn": "text",
  "admin_cn": "text",
  "admin_password": "text",
  "ou": "text",
  "auth_type": "text"
}
{
  "id": 1,
  "host": "text",
  "port": 1,
  "base_dn": "text",
  "admin_cn": "text",
  "ou": "text",
  "auth_type": "text"
}

Get Config

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
config_idintegerRequired
Responses
200

Successful Response

application/json
or
get/api/v1/ldap-configs/{config_id}
GET /api/v1/ldap-configs/{config_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": 1,
  "host": "text",
  "port": 1,
  "base_dn": "text",
  "admin_cn": "text",
  "ou": "text",
  "auth_type": "text"
}

Update Config

put
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
config_idintegerRequired
Body
hoststring · nullableOptional
portinteger · nullableOptional
base_dnstring · nullableOptional
admin_cnstring · nullableOptional
admin_passwordstring · nullableOptional
oustring · nullableOptional
auth_typestringRequired
Responses
200

Successful Response

application/json
or
put/api/v1/ldap-configs/{config_id}
PUT /api/v1/ldap-configs/{config_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "host": "text",
  "port": 1,
  "base_dn": "text",
  "admin_cn": "text",
  "admin_password": "text",
  "ou": "text",
  "auth_type": "text"
}
{
  "id": 1,
  "host": "text",
  "port": 1,
  "base_dn": "text",
  "admin_cn": "text",
  "ou": "text",
  "auth_type": "text"
}

Delete Config

delete
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters
config_idintegerRequired
Responses
200

Successful Response

application/json
Other propertiesanyOptional
delete/api/v1/ldap-configs/{config_id}
DELETE /api/v1/ldap-configs/{config_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Last updated