REST

Overview

The REST connector is designed to manage provisioning by relying on RESTful service.

Installation

Follow these steps to run the stand-alone connector server:

  1. Download the connector server jar file and store it in the connector server directory (any directory).
  2. Download the REST connector jar file and store it in the bundles subdirectory.
  3. Start the connector server. For more information, check the page about this topic.

Supported operations

  • Authenticate
  • ResolveUsername
  • Create
  • Delete
  • Update
  • Search
  • Test
  • Schema
  • Sync
  • ScriptOnConnector
  • UpdateAttributeValues

Configuration

Configuration Properties

The following table describes all of the properties that you can specify for the configuration:

Configuration PropertyTypeRequiredDescription
Base addressStringXBase URL for the target RESTful service
AcceptString
Value for the HTTP Accept header; defaults to application/json
Content-TypeString
Value for the HTTP Content-Type header; defaults to application/json
UsernameString
Username for authentication to the target RESTful service
PasswordGuardedString
Password for authentication to the target RESTful service
Client idString
Client id for authentication to the target RESTful service
Client secretString
Client secret for authentication to the target RESTful service
Access Token node idString
Field id of the JSON object node, returned from target Access Token RESTful service, that contains token value
Access Token base addressString
Base address of the target RESTful service used to obtain access token
Access Token Content-TypeString
Value for the HTTP Content-Type header for the target Access Token RESTful service; defaults to application/x-www-form-urlencoded
Clear Text Password To ScriptBoolean
Should password be passed to scripts in clear text?
Authenticate ScriptString
Authenticate groovy script
Authenticate Script File NameString
Path of authenticate groovy script file
Delete ScriptString
Delete groovy script
Search ScriptString
Search groovy script
Update Script File NameString
Path of update groovy script file
Create ScriptString
Create groovy script
Search Script File NameString
Path of search groovy script file
Create Script File NameString
Path of create groovy script file
Delete Script File NameString
Path of delete groovy script file
Schema Script File NameString
Path of schema groovy script file
Reload Script On ExecutionBoolean

By default, scripts are loaded and compiled when a connector instance is created and initialized.
Setting this parameter to true will make the connector load and compile the script every time it is called.

Use only for test/debug purpose since this can have a significant impact on performance.

Test ScriptString
Test groovy script
Test Script File NameString
Path of test groovy script file
Update ScriptString
Update groovy script
ResolveUsername ScriptString
ResolveUsername groovy script
ResolveUsername Script File NameString
Path of ResolveUsername groovy script file
Scripting LanguageString
The scripting language; only default value GROOVY is currently supported.
Sync Script File NameString
Path of sync groovy script file
Sync Script
String
Sync groovy script