REST

Owned by Francesco Chicchiriccò
Last updated: Dec 28, 2024
2 min read

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 Property

Type

Required

Description

Configuration Property

Type

Required

Description

Base address

String

X

Base URL for the target RESTful service

Accept

String

 

Value for the HTTP Accept header; defaults to application/json

Content-Type

String

 

Value for the HTTP Content-Type header; defaults to application/json

Username

String

 

Username for authentication to the target RESTful service

Password

GuardedString

 

Password for authentication to the target RESTful service

Client id

String

 

Client id for authentication to the target RESTful service

Client secret

String

 

Client secret for authentication to the target RESTful service

Access Token node id

String

 

Field id of the JSON object node, returned from target Access Token RESTful service, that contains token value

Access Token base address

String

 

Base address of the target RESTful service used to obtain access token

Access Token Content-Type

String

 

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 Script

Boolean

 

Should password be passed to scripts in clear text?

Authenticate Script

String

 

Authenticate groovy script

Authenticate Script File Name

String

 

Path of authenticate groovy script file

Delete Script

String

 

Delete groovy script

Search Script

String

 

Search groovy script

Update Script File Name

String

 

Path of update groovy script file

Create Script

String

 

Create groovy script

Search Script File Name

String

 

Path of search groovy script file

Create Script File Name

String

 

Path of create groovy script file

Delete Script File Name

String

 

Path of delete groovy script file

Schema Script File Name

String

 

Path of schema groovy script file

Reload Script On Execution

Boolean

 

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 Script

String

 

Test groovy script

Test Script File Name

String

 

Path of test groovy script file

Update Script

String

 

Update groovy script

ResolveUsername Script

String

 

ResolveUsername groovy script

ResolveUsername Script File Name

String

 

Path of ResolveUsername groovy script file

Scripting Language

String

 

The scripting language; only default value GROOVY is currently supported.

Sync Script File Name

String

 

Path of sync groovy script file

Sync Script

String

 

Sync groovy script

Â