How to create an LDAP domain using the API 'createDomain' in TIBCO Data Virtualization?

How to create an LDAP domain using the API 'createDomain' in TIBCO Data Virtualization?

book

Article ID: KB0072122

calendar_today

Updated On:

Products Versions
TIBCO Data Virtualization All Supported Versions

Description

This article will list the steps to create an LDAP domain using an API instead of having to do this manually from the Web Manager.
 

Issue/Introduction

This article will list the steps to create an LDAP domain using an API instead of having to do this manually from the Web Manager.

Resolution

1. Open the TDV Studio
2. Navigate to:
/services/webservices/system/admin/user/operations/createDomain

3. Click on the Execute button.
4. The details for the LDAP domain need to be added to the XML editor.
5. This can be entered according to the user's choice.
Below is a sample for reference:
================================================================
<user:createDomain xmlns:user="http://www.compositesw.com/services/system/admin/user" xmlns:common="http://www.compositesw.com/services/system/util/common">
  <user:domainName>ldap11</user:domainName>
  <user:domainType>LDAP</user:domainType>

  <user:isBlocking>1</user:isBlocking>
  <user:attributes>
    <common:attribute>
      <common:name>a_domain_subtype</common:name>
      <common:type>STRING</common:type>
      <common:value>active directory</common:value>
      </common:attribute>
      <common:attribute>
    <common:name>a_domain_url</common:name>
      <common:type>STRING</common:type>
      <common:value>ldap://xx.xx.xx.xx/xxx/</common:value>
      </common:attribute>
      <common:attribute>
    <common:name>a_domain_admin_name</common:name>
      <common:type>STRING</common:type>
      <common:value>admin</common:value>  
    </common:attribute>
    <common:attribute>
    <common:name>a_domain_admin_password</common:name>
      <common:type>PASSWORD_STRING</common:type>
      <common:value>password</common:value> 
    </common:attribute>
  </user:attributes>
</user:createDomain>
6. Once the details are verified, click on the Ok button
7. If all the information provided is valid, a SUCCESS message will be displayed in the Results tab.

The Domain management page can be opened in Web Manager to confirm the creation of the LDAP domain.