Setup connector app in Opal

Connect Opal to your connector instance.

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!

Create a custom app

Go to the Inventory page, click the + App button on the top right. Select on the Custom App tile, then the Use custom app connector option.

Use the following values to configure the connector in Opal.

FieldSettingRequired
IdentifierUse any value you need, depending on how you use the app_id parameter from the API spec.Yes
Base URLYour connector hostname and port, including protocol. For example, https://customconnector.company.com:8090.Yes
Connector GroupsEnable this option if you've implemented the /groups endpoints. If your connector does not require groups, leave it disabled.No
Nested ResourcesEnable this option if your connector requires nested resources. Ensure your connector implements the spec correctly, otherwise side effects may arise.No

Select Generate to generate a signing secret, and use this code into your connector to verify that the X-Opal-Signature header is correct and authentic. See Signatures for more.

Select 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.