Provided that you created and set up your connector successfully by following Create your own connector and API Spec, the next step is to connect the connector in Opal and start managing access!

Getting Started

To get started, head to the Catalog page, click the + App button on the top right. Then, click on the Custom App tile.

Enter your connector info into Opal

Enable the "Use custom app connector" option.

As "Identifier" you can enter any value you need, depending on how you use the app_id param in the connector requests as specified in the API Spec. This value is required in Opal when setting up the app.

"Base URL" will be your connector hostname and port, including the protocol of choice (eg. https://customconnector.company.com:8090).

Generate a signing secret using the Generate button, and use this code into your connector to verify that the X-Opal-Signature header is correct and authentic.

If your connector doesn't require groups, or it doesn't support the /groups endpoints, you leave "Connector Groups" as disabled, otherwise tick the check if your connector has the /groups endpoints implemented.

If your connector requires nested resources, enable "Nested Resources", note that enabling "Nested Resources" and your connector doesn't implement the spec correctly, side-effects may arise.

Finally, click on "Create Custom App" to verify that the connector is properly set up, if successful the connection will be created and you can now manage your access with Opal!