RadiantOne offers a REST-based API that can be used for issuing configuration commands. Each topic explains the different commands along with their syntax.

This content is broken down into the following topics:

Global Configuration Commands
This chapter explains how to display and set RadiantOne global configuration property values.

Node Configuration Commands
This chapter explains how to display and set RadiantOne cluster node configuration property values.

Data Source Commands
This chapter describes how to create and delete database and LDAP data sources. It also explains how to update and print data source information.

Naming Context Commands
This chapter describes how to create persistent caches, naming contexts, proxy naming contexts, and backup images of Universal Directory (HDAP) stores. It also describes how to delete naming contexts and their caches.

Tree Hierarchy Commands
This chapter explains how to manage node properties in a virtual tree.

Object and Attribute Commands
This chapter explains how to perform various object and attribute commands including joins and merged trees.

Task Launch Commands
This chapter describes how to launch tasks to initialize a cache, a Universal Directory (HDAP) store from LDIF file, and export data from an LDAP data source to LDIF file.

Naming Context Property Commands
This chapter explains how to display a list of accepted property names, and how to set, print, and remove the current value for a property.

ACI Commands
This chapter describes access control commands and how to configure them.

LDAP Schema Commands
This chapter covers publishing and removing an ORX’s schema from the RadiantOne LDAP schema.

Password Policy Commands
This chapter explains how to add, update, and remove a password policy.

Log Settings Commands
This chapter describes how to configure log settings.

Monitoring and Alert Settings Commands
This chapter describes how to configure monitoring and alert settings.

Migration Commands
This chapter explains how to migrate resources from an existing development/QA environment to an existing production environment.

Security Commands
This chapter explains how to define the attribute encryption cipher and key. Commands to add and remove client certificates and enable FIPS-mode are also discussed.

ORX and DVX Commands
This chapter explains how to list existing orx and dvx files, and view and test the connection to the backend data source associated with the files.

Search Commands
This chapter explains how to search the RadiantOne namespace.

Real-time Persistent Cache Refresh Commands
This chapter explains how to configure real-time persistent cache refresh.

Configuring Global Synchronization
This chapter explains how to configure the components used for global synchronization.

Converting LDIF files to CSV
This chapter explains how to convert LDIF files to CSV.

The syntax of the URL is as follows.

http://<RadiantOne_REST_Endpoint/adap/util?action=vdsconfig&commandname=<commandname>&<param>=<paramvalue>&<param>=<paramvalue>

Results are returned in the response. A successful operation’s response contains an exit code value of 0 and a “systemOut” message. An unsuccessful operation’s response contains an exit code of 1 and a system error message. If a required parameter is missing from the URL, the response returns the following error.

"SystemErr": "Parsing failed. Reason: Missing required option"

Examples of ADAP requests follow the descriptions of the commands that support it in this guide.

ADAP responses are formatted as shown below.

Basic Password Authentication

All REST (ADAP) operations require a header which is used to bind to the RadiantOne LDAP service. If this header is not populated, an HTTP status 403 results. The user that performs the bind must be a member of one of the following RadiantOne delegated admin groups:

• Directory Administrator
• Namespace Administrator
• Operator
• ICS Administrator

An example is shown below.

Header name: Authorization
Header value: Basic <username>:<password>
Ex: Basic cn=directory manager:password

The username:password value can be passed base64 encoded. Ex: Basic Y249ZGlyZWN0b3J5IG1hbmFnZXI6cGFzc3dvcmQ=