Retrieve All LDAP Realm Configurations

The example shows the sample responses obtained based on the realms configured on the LDAP server.

Before proceeding with the example, ensure that the following conditions are met:

1. The TIBCO Enterprise Administrator server is running.
2. Provide the administrator credentials to handle Basic authentication.
3. HTTP URL: http://[tea-server-hostname]:[port]/teas/task
4. HTTP Method: PUT
5. HTTP Request Headers: Content-Type: application/json

The following is the sample request body to retrieve all LDAP realm configurations:

{
 "operation":"getLdapRealmConfigs",
 "methodType":"READ",
 "objectId":"tea:tea::realms:"
}
  

When there are LDAP realms available, they are returned as an Array of Maps against the result key. The following is the sample response when there are realms available on the LDAP server:

{ "agentId" : "tea",
  "error" : null,
  "id" : "21cc6a2a66-14399518403-21",
  "operation" : "getldaprealmconfigs",
  "progress" : 100,
  "progressStatus" : "DONE",
  "result" : [ { "bindPassword" : "secret",
        "bindUserDN" : "uid=admin,ou=system",
        "description" : "acme description",
        "groupIdAttribute" : "cn",
        "groupSearchBaseDN" : "ou=Special Groups,dc=example,dc=com",
        "groupSearchExpression" : "cn={0}",
        "groupUsersAttribute" : "uniquemember",
        "groups" : [  ],
        "realmName" : "acme",
        "searchTimeOut" : 10005,
        "serverUrl" : "ldap://acme.na.tibco.com:10389/",
        "subGroupsAttribute" : "uniquemember",
        "userIdAttribute" : "uid",
        "userPasswordAttribute" : "userPassword",
        "userSearchBaseDN" : "ou=Special Users,dc=example,dc=com",
        "userSearchExpression" : "(&(uid={0})(objectclass=*))",
        "users" : [  ]
      },
      { "bindPassword" : "password",
        "bindUserDN" : "cn=Directory Manager",
        "description" : "SunONE description",
        "groupIdAttribute" : "cn",
        "groupSearchBaseDN" : "ou=groups,dc=policy,dc=tibco,dc=com",
        "groupSearchExpression" : "cn={0}",
        "groupUsersAttribute" : "uniquemember",
        "groups" : [  ],
        "realmName" : "SunONE",
        "searchTimeOut" : 10000,
        "serverUrl" : "ldap://10.97.107.23:389",
        "subGroupsAttribute" : "uniquemember",
        "userIdAttribute" : "uid",
        "userPasswordAttribute" : "userPassword",
        "userSearchBaseDN" : "ou=people,dc=policy,dc=tibco,dc=com",
        "userSearchExpression" : "(&(uid={0})(objectclass=*))",
        "users" : [  ]
      }
    ],
  "returnType" : null,
  "status" : "DONE",
  "timeCreated" : 622351252380946,
  "timeFinished" : 622351333309405,
  "userId" : "admin"
}

The following is the sample response when there are no realms configured on the LDAP server:

{ "agentId" : "tea",
  "error" : null,
  "id" : "21cc6a2a66-14399518403-25",
  "operation" : "getldaprealmconfigs",
  "progress" : 100,
  "progressStatus" : "DONE",
  "result" : [  ],
  "returnType" : null,
  "status" : "DONE",
  "timeCreated" : 622707877203368,
  "timeFinished" : 622707877656611,
  "userId" : "admin"
}