Create an OAuth Client
An OAuth client must be created in the Lobby to use Aconex and Lobby APIs.
To create an OAuth client:
- Select Navigation Menu and select OAuth Clients.
- Select Add.
- On the Add OAuth Client panel, complete the following fields:
- Name: Enter a unique and meaningful name for the integration.
If you think you will only ever have one integration, you can simply use your organization name like "Majestic Inc.".
If you intend to build multiple integrations, consider a name that describes the purpose of the integration like "Majestic Inc. Package Builder".
- Description: Enter a meaningful description for the integration, such as "Connects Majestic's Package Builder with Aconex".
- Resource Application: Select Aconex or Lobby as the resource application.
- Type: Select the type of integration. Options are Web Server Application, Installed Application, Non-Interactive Integration, and User-Bound Integration (not available when Lobby is selected as the Resource Application). For additional details, see OAuth Clients.
- If you selected Web Server Application or Installed Application, complete the following:
- Redirect URL: Enter a redirect URL. To add an additional URL, select Add Redirect URL. See Redirect URLs below more more details.
- Organizations: Select one or more organizations to which the client will be provisioned. The list displays the organizations for which you are an organization administrator. For User-Bound Integration, this is your home organization. The Organizations field does not display.
- If you selected User-Bound Integration, complete the following:
- User Account: Select a Lobby user account that will be bound to the integration. The Lobby user account will be linked to one or more Aconex user accounts.
- If your Resource Application is Aconex, review and acknowledge the Terms of Use section.
- Select Add.
- If you selected Non-Interactive Integration, contact Oracle Support to provide your public certificate. If you have your own identity domain, you can upload the certificate.
- Name: Enter a unique and meaningful name for the integration.
Redirect URLs
You may add a single redirect URL or multiple.
Check with your technical team for what redirect URLs need to be configured for this OAuth client.
If you are creating an Installed Application, RFC 8252 states that should use either a Private-user URI scheme redirect or a Loopback redirect URI, each of which are described below.
A Private-user URI scheme redirect uses a custom URI scheme that has been added on the device for your application, taking the form:
scheme:/path
register
Here's an example:
com.example.app:/oauth2/callback
A Loopback redirect URI uses the "http" scheme with the loopback IP literal and whatever port the application is listening on, taking the form:
http://127.0.0.1:{port}/{path}
Here's an example:
http://127.0.0.1:54001/oauth2/callback
If your Installed Application loops through a number of ports to find an available port for binding the callback, you may add a single loopback redirect URI with a wildcard (*) port identifier, rather than multiple redirect URIs.
Last Published Friday, December 6, 2024