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

LDAP User Authentication

Login With Cert

post

Upload certificate (PEM/DER/PFX/P12) and authenticate. Please Note password is only required for .pfx/.p12 files, for .pem/.der just upload the cert without password.

Body
filestring · binaryRequired
passwordstringOptional
Responses
200

Successful Response

application/json
anyOptional
post/api/v1/user_authentication/login_with_cert
POST /api/v1/user_authentication/login_with_cert HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 35

{
  "file": "binary",
  "password": "text"
}

No content

Login

post
Body
usernamestringRequired
passwordstringRequired
oustringOptional
Responses
200

Successful Response

application/json
anyOptional
post/api/v1/user_authentication/login
POST /api/v1/user_authentication/login HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "username": "text",
  "password": "text",
  "ou": "text"
}

No content

Logout

post
Query parameters
tokenstringRequired
Responses
200

Successful Response

application/json
anyOptional
post/api/v1/user_authentication/logout
POST /api/v1/user_authentication/logout?token=text HTTP/1.1
Accept: */*

No content

Verify Token

get
Query parameters
tokenstringRequired
Responses
200

Successful Response

application/json
anyOptional
get/api/v1/user_authentication/verify
GET /api/v1/user_authentication/verify?token=text HTTP/1.1
Accept: */*

No content

Add User Api

post
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Body
cnstringRequired
snstringRequired
given_namestringRequired
emailstring · emailRequired
passwordstringRequired
Responses
200

Successful Response

application/json
anyOptional
post/api/v1/user_authentication/add_user
POST /api/v1/user_authentication/add_user HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "cn": "text",
  "sn": "text",
  "given_name": "text",
  "email": "name@gmail.com",
  "password": "text"
}

No content

Search Users Api

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Query parameters
oustringRequired
Responses
200

Successful Response

application/json
anyOptional
get/api/v1/user_authentication/search_users
GET /api/v1/user_authentication/search_users?ou=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Modify User Email Api

put
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Query parameters
cnstringRequired
new_emailstringRequired
Responses
200

Successful Response

application/json
anyOptional
put/api/v1/user_authentication/modify_user_email
PUT /api/v1/user_authentication/modify_user_email?cn=text&new_email=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete User Api

delete
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Query parameters
cnstringRequired
Responses
200

Successful Response

application/json
anyOptional
delete/api/v1/user_authentication/delete_user
DELETE /api/v1/user_authentication/delete_user?cn=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Check User Exists Api

get
Authorizations
AuthorizationstringRequired

Enter your JWT token (without 'Bearer ' prefix)

Query parameters
cnstringRequired
oustringOptional
check_for_adminbooleanOptionalDefault: false
Responses
200

Successful Response

application/json
anyOptional
get/api/v1/user_authentication/check_user_exists
GET /api/v1/user_authentication/check_user_exists?cn=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated