Skip to main content

REST

You can use the Representational State Transfer (REST) connectivity to connect to systems without a dedicated connectivity for Omada Identity. The Omada REST connectivity serves as a generic connector for APIs that have been built using REST web services. The Omada REST connectivity serves as a foundation for other connectors - the connector is available in a default installation when you select to register a new system in Omada Identity.

The REST connector allows you to perform the following actions:

  • Make HTTP requests with specified verbs on a specified URL.
  • Specify custom JSON payloads.
  • Specify a security protocol.
  • Specify authentication protocols.
  • Specify OAuth authentication protocols for client credentials and passwords.
  • Configure token expiration based on policies, like persisting tokens, new tokens, and time-based tokens.
  • Analyze the body of response codes.

Supported objects and operations​

REST connectivity supports both identity and access rights data. The following operations are supported (HTTP methods are listed in parentheses) on all data object types:

  • Create (POST)
  • Read (GET)
  • Update (PUT)
  • Delete (DELETE)

Aditionally, the following operations are supported:

  • CreateOrUpdate - creates or updates one or more objects, depending on the information provided.
  • DeleteIfExists - checks whether the object exists. If the object exists, the operation then proceeds to delete it. No action is taken if the object does not exist.
  • CreateIfNotExist - checks whether the object exists. If the object does not exist, then the operation proceeds to create it. No action is taken if the object exists.

It is also possible to only import to the Staging database by enabling the Store data for reporting setting. This allows you to inspect the data and adjust the system onboarding configuration without storing any history. This setting is enabled by default and applies to the full system category. If you disable this setting, the data for the system category is only imported to the staging database.

Minimum required permissions​

You should have access to the REST API, including relevant permissions.

Implementation notes​

The Omada generic REST connector does not require any target system configuration.

Error codes overview​

Transient failure
Any error other than Unauthorized error (401).

Permanent failure
Unauthorized error (401). The request is attempted a second time, and if it fails with same error, permanent failure occurs. If it fails with a different error, a transient error is returned.

Prerequisites​

None.