API v2: User Directory Configuration πŸ†•ΒΆ


Data StructuresΒΆ

UserDirectoryModelΒΆ

Attribute

Type

Required

Description

id

string

Read-only, unique object identifier.

name

string

yes

Case-insensitive, unique name.

type

string {AD, LDAP}; default value AD

yes

Immutable.

position

number

Unique.

username

string

yes

Unique.

password

string

yes

Protected.

dn

string

yes

base_user

string

base_group

string

user_domain

string

user_filter

string; default value (&(objectclass=user))

yes

group_filter

string; default value (&(objectclass=group))

server_lastupdate

string

Timestamp.

db_lastupdate

string

Timestamp.

login_field

string; default value sAMAccountName

yes

mail_field

string; default value mail

memberof_field

string; default value memberOf

yes

telephone_field

string; default value telephoneNumber

company_field

string; default value company

displayname_field

string; default value displayName

yes

dn_field

string; default value distinguishedName

yes

certificate_field

string; default value userCertificate

yes

guid_field

string; default value objectGUID

yes

auto_block

boolean; default value true

yes

x509_certificate_method

boolean; default value false

yes

x509_sshkey_method

boolean; default value false

yes

created_at

datetime

Read-only. Timestamp ofΒ creation.

modified_at

datetime

Read-only. Timestamp ofΒ modification.

removed

boolean

Read-only.

Retrieve Available Attributes of the UserDirectoryModelΒΆ

Request

Method

GET

Path

/api/v2/objspec/user_directory

To check allowed methods, available URL parameters and possible responses please refer to the API Overview section.


Get Existing User Directory ConfigurationsΒΆ

Request

Method

GET

Path

/api/v2/user_directory

GET /api/v2/user_directory

Example Request

curl -s -k -X GET \
-H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' \
'https://10.0.214.98/api/v2/user_directory'

Response

{
    "result": "success",
    "user_directory": [
        {
            "id": "9115285645797883905",
            "name": "active-directory-10.0.100.100",
            "type": "AD",
            "position": 0,
            "username": "Administrator",
            "dn": "ad.com",
            "base_user": "dc=ad,dc=com",
            "base_group": "dc=ad,dc=com",
            "user_domain": "fudo-ad.com",
            "user_filter": "(&(objectclass=user))",
            "group_filter": "(&(objectclass=group))",
            "login_field": "sAMAccountName",
            "mail_field": "mail",
            "memberof_field": "memberOf",
            "telephone_field": "telephoneNumber",
            "company_field": "company",
            "displayname_field": "displayName",
            "dn_field": "distinguishedName",
            "certificate_field": "userCertificate",
            "guid_field": "objectGUID",
            "auto_block": true,
            "x509_certificate_method": false,
            "x509_sshkey_method": false,
            "created_at": "2025-05-05 04:51:54.021816-07",
            "modified_at": "2025-05-05 04:51:54.021816-07"
        }
    ]
}

Get Existing User Directory Configuration by IDΒΆ

Request

Method

GET

Path

/api/v2/user_directory/<id>

GET /api/v2/user_directory/<id>

Example Request

curl -s -k -X GET \
-H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' \
'https://10.0.214.98/api/v2/user_directory/801640733671948289'

Response

{
    "result": "success",
    "user_directory": {
        "id": "9115285645797883908",
        "name": "ldap-10.0.200.100 [domain: ldap.com]",
        "type": "LDAP",
        "position": 3,
        "username": "cn=admin,dc=ldap,dc=com",
        "dn": "cn=admin,dc=ldap,dc=com",
        "base_user": "dc=ldap,dc=com",
        "base_group": "dc=ldap,dc=com",
        "user_domain": "ldap.com",
        "user_filter": "(objectClass=inetOrgPerson)",
        "group_filter": "(objectClass=groupOfNames)",
        "login_field": "uid",
        "mail_field": "mail",
        "memberof_field": "memberOf",
        "telephone_field": "telephoneNumber",
        "company_field": "o",
        "displayname_field": "displayName",
        "dn_field": "dn",
        "certificate_field": "userCertificate",
        "guid_field": "dn",
        "auto_block": true,
        "x509_certificate_method": false,
        "x509_sshkey_method": false,
        "created_at": "2025-05-05 04:51:54.039467-07",
        "modified_at": "2025-05-05 05:00:18.099246-07"
    }
}

Defining User Directory ConfigurationΒΆ

Request

Method

POST

Path

/api/v2/user_directory

Headers

Content-Type: Application/json

Body

UserDirectoryModel

POST /api/v2/user_directory

Example Request

curl -s -k -X POST \
  -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' \
  -H 'Content-Type: application/json' \
  https://10.31.87.227/api/v2/user_directory \
  -d '{
    "name": "ldap-10.0.100.200 [domain: ldap.com]",
    "type": "LDAP",
    "position": 3,
    "username": "cn=admin,dc=ldap,dc=com",
    "password": "password",
    "dn": "cn=admin,dc=ldap,dc=com",
    "base_user": "dc=ldap,dc=com",
    "base_group": "dc=ldap,dc=com",
    "user_domain": "ldap.com",
    "user_filter": "(objectClass=inetOrgPerson)",
    "group_filter": "(objectClass=groupOfNames)",
    "login_field": "uid",
    "mail_field": "mail",
    "memberof_field": "memberOf",
    "telephone_field": "telephoneNumber",
    "company_field": "o",
    "displayname_field": "displayName",
    "dn_field": "dn",
    "certificate_field": "userCertificate",
    "guid_field": "dn"
  }'

Response

{
    "result": "success",
    "user_directory": {
        "id": "9115285645797883909"
    }
}

Modify User Directory ConfigurationΒΆ

Request

Method

PATCH

Path

/api/v2/user_directory/<id>

Headers

Content-Type: Application/json

Body

UserDirectoryModel

PATCH /api/v2/user_directory/<id>

Example Request

curl -s -k -X PATCH \
  -H 'Authorization: sgfeea6jsaz4mum9su8w61877n1g06sk' \
  -H 'Content-Type: application/json' \
  https://10.31.87.227/api/v2/user_directory/9115285645797883909 \
  -d '{
    "name":"ldap-other-name",
    "position":5,
    "password":"different"
  }'

Response

{
    "result": "success"
}

Deleting User Directory ConfigurationΒΆ

Request

Method

DELETE

Path

/api/v2/user_directory/<id>

DELETE /api/v2/user_directory/<id>

Example Request

curl -s -k -X DELETE \
-H 'Authorization:vg1ei6rgo58fsbobr7octp0w3afd9vsm' \
https://10.31.87.227/api/v2/user_directory/9115285645797883908

Response

{
    "result": "success"
}