Identity Broker Rest API Operation

Overview

The Identity Broker Rest API operation is an extension of the Rest API Operation and allows UNIFYNow to invoke UNIFYBroker operations via the UNIFYBroker Rest API.

The Identity Broker Rest API operation uses the Rest API agent. It does not use the Identity Broker agent.

Technical Requirements

The Identity Broker Rest API operation requires:

  • An instance of Identity Broker/UNIFYBroker v5.0 or greater
  • An unobstructed network route between UNIFYNow and UNIFYBroker on the correct port (default: 59991)

Usage

The Identity Broker Rest API operation can be used to invoke the internal UNIFYBroker operations which have been made available though the UNIFYBroker Rest API.

TIP: If UNIFYBroker requests other than the ones supported by this operations, or requests to other REST servicesĀ are desired, use theĀ Rest API Operation.

Success / Failure Result

The operation is always considered a success if the web request succeeds. If the request cannot be sent or the response is not received the operation will fail and prevent the operation list from continuing operation.

Configuration

In addition to the common operation configuration settings shared by all standard operations, the Identity Broker Rest API operation requires the following by way of configuration:

Name
Description
Operation Type The type of UNIFYBroker operation to invoke.
Connector ID The GUID identifier of the UNIFYBroker connector for which to operate on.
Run Asynchronously If checked, the operation list will continue without waiting for the REST request to complete and the operation will always succeed, regardless of the outcome of the request.
CHECK: A Rest API agent is required to configure a Identity Broker Rest API operation.


UNIFYBroker Standard Operation Rest API Operation

Is this article helpful for you?