/
LDAP Web Services

LDAP Web Services

Sept 03, 2025

 

Overview

Universal Controller supports the following RESTful-based web services for Virtual Resource operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about parameter requirements, are provided.

Read LDAP Settings

 

 Description

 

 Description

Consumes Content-Type

N/A

Description

Get LDAP Settings

Authentication

HTTP Basic

URI

http://host_name/uc/resources/ldap

HTTP Method

GET

Example URI

http://localhost:8080/uc/resources/ldap

Produces Content-Type

 application/xml, application/json

Read LDAP Settings: XML and JSON Examples

XML

JSON

XML

JSON

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ldap exportReleaseLevel="7.6.0.0" exportTable="ops_ldap">

    <allowLocalLogin>false</allowLocalLogin>

    <baseDn>DC=qad,DC=stone,DC=branch</baseDn>

    <bindDn>administrator@qad</bindDn>

    <bindPassword />

    <connectTimeout>5</connectTimeout>

    <groupFilter>(&(objectClass=group)(objectCategory=group)(|(cn=GroupA)(memberOf:1.2.840.113556.1.4.1941:=CN=GroupA,OU=TestGroups,DC=qad,DC=stone,DC=branch)))</groupFilter>

    <groupMemberAttribute />

    <groupTargetOuList>

        <targetOu>OU=TestUsers</targetOu>

        <targetOu>OU=TestOtherUsers</targetOu>

    </groupTargetOuList>

    <loginMethod>Standard, Single Sign-On</loginMethod>

    <mappings>

        <mapping type="Group" column="manager">managedBy</mapping>

        <mapping type="Group" column="email">mail</mapping>

        <mapping type="User" column="manager">manager</mapping>

        <mapping type="User" column="phone">telephoneNumber</mapping>

        <mapping type="User" column="department">department</mapping>

        <mapping type="User" column="first_name">givenName</mapping>

        <mapping type="User" column="last_name">sn</mapping>

        <mapping type="User" column="mobile_phone">mobile</mapping>

        <mapping type="User" column="home_phone">homePhone</mapping>

        <mapping type="User" column="email">mail</mapping>

        <mapping type="User" column="title">title</mapping>

        <mapping type="Group" column="description">description1</mapping>

        <mapping type="User" column="middle_name">initials</mapping>

    </mappings>

    <readTimeout>30</readTimeout>

    <sysId>bb678a4f4d2c4fc4a1dc93b1ffe4bdfc</sysId>

    <url>ldap://qa-dc1.stone.branch:389</url>

    <useForAuthentication>true</useForAuthentication>

    <userFilter>(&(objectClass=user)(objectCategory=person)(memberOf:1.2.840.113556.1.4.1941:=CN=GroupA,OU=TestGroups,DC=qad,DC=stone,DC=branch))</userFilter>

    <userIdAttribute>sAMAccountName</userIdAttribute>

    <userMembershipAttribute>user member</userMembershipAttribute>

    <userTargetOuList>

        <targetOu>OU=TestUsers</targetOu>

        <targetOu>OU=TestOtherUsers</targetOu>

    </userTargetOuList>

</ldap>

{

    "allowLocalLogin": false,

    "baseDn": "DC=qad,DC=stone,DC=branch",

    "bindDn": "administrator@qad",

    "bindPassword": null,

    "connectTimeout": 5,

    "exportReleaseLevel": "7.6.0.0",

    "exportTable": "ops_ldap",

    "groupFilter": "(&(objectClass=group)(objectCategory=group)(|(cn=GroupA)(memberOf:1.2.840.113556.1.4.1941:=CN=GroupA,OU=TestGroups,DC=qad,DC=stone,DC=branch)))",

    "groupMemberAttribute": null,

    "groupTargetOuList": null,

    "loginMethod": "Standard, Single Sign-On",

    "mappings": [

        {

            "attribute": "managedBy",

            "column": "manager",

            "type": "Group"

        },

        {

            "attribute": "mail",

            "column": "email",

            "type": "Group"

        },

        {

            "attribute": "manager",

            "column": "manager",

            "type": "User"

        },

        {

            "attribute": "telephoneNumber",

            "column": "phone",

            "type": "User"

        },

        {

            "attribute": "department",

            "column": "department",

            "type": "User"

        },

        {

            "attribute": "givenName",

            "column": "first_name",

            "type": "User"

        },

        {

            "attribute": "sn",

            "column": "last_name",

            "type": "User"

        },

        {

            "attribute": "mobile",

            "column": "mobile_phone",

            "type": "User"

        },

        {

            "attribute": "homePhone",

            "column": "home_phone",

            "type": "User"

        },

        {

            "attribute": "mail",

            "column": "email",

            "type": "User"

        },

        {

            "attribute": "title",

            "column": "title",

            "type": "User"

        },

        {

            "attribute": "description1",

            "column": "description",

            "type": "Group"

        },

        {

            "attribute": "initials",

            "column": "middle_name",

            "type": "User"

        }

    ],

    "readTimeout": 30,

    "sysId": "bb678a4f4d2c4fc4a1dc93b1ffe4bdfc",

    "url": "ldap://qa-dc1.stone.branch:389",

    "useForAuthentication": true,

    "userFilter": "(&(objectClass=user)(objectCategory=person)(memberOf:1.2.840.113556.1.4.1941:=CN=GroupA,OU=TestGroups,DC=qad,DC=stone,DC=branch))",

    "userIdAttribute": "sAMAccountName",

    "userMembershipAttribute": "user member",

    "userTargetOuList": [

        "OU=TestUsers",

        "OU=TestOtherUsers"

    ]

}

Update LDAP Settings

 

 Description

 

 Description

Consumes Content-Type

 application/xml, application/json

Description

Modify LDAP Settings

Authentication

HTTP Basic

URI

http://host_name/uc/resources/ldap

HTTP Method

PUT

Example URI

http://localhost:8080/uc/resources/ldap

Produces Content-Type

 application/xml, application/json

Example Responses

  • Status 200

    • Successfully updated the LDAP Setting with id {uuid}.

  • Status 400

    • Error message.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • LDAP Setting with id "{uuid}" not found.

  • Status 500

    • Unexpected request failure. See log(s) for more details.

Update LDAP Settings: XML and JSON Examples

XML

JSON

XML

JSON

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ldap exportReleaseLevel="7.6.0.0" exportTable="ops_ldap">

    <allowLocalLogin>false</allowLocalLogin>

    <baseDn>DC=qad,DC=stone,DC=branch</baseDn>

    <bindDn>administrator@qad</bindDn>

    <bindPassword />

    <connectTimeout>5</connectTimeout>

    <groupFilter>(&(objectClass=group)(objectCategory=group)(|(cn=GroupA)(memberOf:1.2.840.113556.1.4.1941:=CN=GroupA,OU=TestGroups,DC=qad,DC=stone,DC=branch)))</groupFilter>

    <groupMemberAttribute />

    <groupTargetOuList>

        <targetOu>OU=TestUsers</targetOu>

        <targetOu>OU=TestOtherUsers</targetOu>

    </groupTargetOuList>

    <loginMethod>Standard, Single Sign-On</loginMethod>

    <mappings>

        <mapping type="Group" column="manager">managedBy</mapping>

        <mapping type="Group" column="email">mail</mapping>

        <mapping type="User" column="manager">manager</mapping>

        <mapping type="User" column="phone">telephoneNumber</mapping>

        <mapping type="User" column="department">department</mapping>

        <mapping type="User" column="first_name">givenName</mapping>

        <mapping type="User" column="last_name">sn</mapping>

        <mapping type="User" column="mobile_phone">mobile</mapping>

        <mapping type="User" column="home_phone">homePhone</mapping>

        <mapping type="User" column="email">mail</mapping>

        <mapping type="User" column="title">title</mapping>

        <mapping type="Group" column="description">description1</mapping>

        <mapping type="User" column="middle_name">initials</mapping>

    </mappings>

    <readTimeout>30</readTimeout>

    <sysId>bb678a4f4d2c4fc4a1dc93b1ffe4bdfc</sysId>

    <url>ldap://qa-dc1.stone.branch:389</url>

    <useForAuthentication>true</useForAuthentication>

    <userFilter>(&(objectClass=user)(objectCategory=person)(memberOf:1.2.840.113556.1.4.1941:=CN=GroupA,OU=TestGroups,DC=qad,DC=stone,DC=branch))</userFilter>

    <userIdAttribute>sAMAccountName</userIdAttribute>

    <userMembershipAttribute>user member</userMembershipAttribute>

    <userTargetOuList>

        <targetOu>OU=TestUsers</targetOu>

        <targetOu>OU=TestOtherUsers</targetOu>

    </userTargetOuList>

</ldap>

{

    "allowLocalLogin": false,

    "baseDn": "DC=qad,DC=stone,DC=branch",

    "bindDn": "administrator@qad",

    "bindPassword": null,

    "connectionTimeout": 5,

    "exportReleaseLevel": "7.6.0.0",

    "exportTable": "ops_ldap",

    "groupFilter": "(&(objectClass=group)(objectCategory=group)(|(cn=GroupA)(memberOf:1.2.840.113556.1.4.1941:=CN=GroupA,OU=TestGroups,DC=qad,DC=stone,DC=branch)))",

    "groupMemberAttribute": null,

    "groupTargetOuList": null,

    "loginMethod": "Standard, Single Sign-On",

    "mappings": [

        {

            "attribute": "managedBy",

            "column": "manager",

            "type": "Group"

        },

        {

            "attribute": "mail",

            "column": "email",

            "type": "Group"

        },

        {

            "attribute": "manager",

            "column": "manager",

            "type": "User"

        },

        {

            "attribute": "telephoneNumber",

            "column": "phone",

            "type": "User"

        },

        {

            "attribute": "department",

            "column": "department",

            "type": "User"

        },

        {

            "attribute": "givenName",

            "column": "first_name",

            "type": "User"

        },

        {

            "attribute": "sn",

            "column": "last_name",

            "type": "User"

        },

        {

            "attribute": "mobile",

            "column": "mobile_phone",

            "type": "User"

        },

        {

            "attribute": "homePhone",

            "column": "home_phone",

            "type": "User"

        },

        {

            "attribute": "mail",

            "column": "email",

            "type": "User"

        },

        {

            "attribute": "title",

            "column": "title",

            "type": "User"

        },

        {

            "attribute": "description1",

            "column": "description",

            "type": "Group"

        },

        {

            "attribute": "initials",

            "column": "middle_name",

            "type": "User"

        }

    ],

    "readTimeout": 30,

    "sysId": "bb678a4f4d2c4fc4a1dc93b1ffe4bdfc",

    "url": "ldap://qa-dc1.stone.branch:389",

    "useForAuthentication": true,

    "userFilter": "(&(objectClass=user)(objectCategory=person)(memberOf:1.2.840.113556.1.4.1941:=CN=GroupA,OU=TestGroups,DC=qad,DC=stone,DC=branch))",

    "userIdAttribute": "sAMAccountName",

    "userMembershipAttribute": "user member",

    "userTargetOuList": [

        "OU=TestUsers",

        "OU=TestOtherUsers"

    ]