LDAP Configurations

Get All Configs

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Responses

200

Successful Response

application/json

or

get

/api/v1/ldap-configs

HTTPcURLJavaScriptPython

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"
  }
]

Create Ldap Config

post

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body

application/json

hoststringRequired

portintegerOptionalDefault: 389

base_dnstringRequired

admin_cnstringRequired

admin_passwordstringRequired

oustringRequired

Responses

200

Successful Response

application/json

or

422

Validation Error

application/json

post

/api/v1/ldap-configs

HTTPcURLJavaScriptPython

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

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

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

Get Config

get

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

config_idintegerRequired

Responses

200

Successful Response

application/json

or

422

Validation Error

application/json

get

/api/v1/ldap-configs/{config_id}

HTTPcURLJavaScriptPython

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"
}

Update Config

put

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

config_idintegerRequired

Body

application/json

hostany ofOptional

stringOptional

or

nullOptional

portany ofOptional

integerOptional

or

nullOptional

base_dnany ofOptional

stringOptional

or

nullOptional

admin_cnany ofOptional

stringOptional

or

nullOptional

admin_passwordany ofOptional

stringOptional

or

nullOptional

ouany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

or

422

Validation Error

application/json

put

/api/v1/ldap-configs/{config_id}

HTTPcURLJavaScriptPython

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

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

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

Delete Config

delete

Authorizations

Bearer Token

AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Path parameters

config_idintegerRequired

Responses

200

Successful Response

application/json

Other propertiesanyOptional

422

Validation Error

application/json

delete

/api/v1/ldap-configs/{config_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/ldap-configs/{config_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}