Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to BlackBaud Raiser's Edge NXT via a desktop application or a headless machine.

However, you must create a custom OAuth application to connect to BlackBaud Raiser's Edge NXT via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

• control branding of the authentication dialog;
• control the redirect URI that the application redirects the user to after the user authenticates; or
• customize the permissions that you are requesting from the user.

The following sections desribe how to create and register a custom OAuth application, and how to connect it to your BlackBaud Raiser's Edge NXT environment.

Create and Register the Custom Application

To create an application to obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret:

1. Go to BlackBaud Sign Up.
2. Set up a developer account and get a subscription key, as described in the BlackBaud Getting Started documentation.
3. Log in at https://app.blackbaud.com/subscriptions.
4. To request a subscription to an API, select SKY API Standard Edition.
5. Select Subscribe. A confirmation screen appears.
6. To submit your request, select Confirm.

BlackBaud sends an email notification when your request is approved. After it is approved, you can view the subscription key within your developer profile.

To register the custom OAuth application:

1. From My Applications (see https://developer.blackbaud.com/apps), select Register app.
2. Enter your application details, including the redirect URI:
   • For Desktop applications, use http://localhost:33333 or another port of your choice.
   • For Web applications, use a URL where you want users to land after granting access to your custom application.
3. Click Save. Your application details are now available in the Blackbaud Marketplace.

Connect the Custom Application to Your Environment

Once the new application is configured and registered in the Blackbaud Marketplace, an environment administrator must connect it to the environment where it will be used.

They should:

1. Navigate to the Blackbaud Marketplace at https://app.blackbaud.com/marketplace/.
2. Visit the Manage page.
3. Select Connect app and specify the application ID of the custom OAuth application that was just created.
4. Select Connect.

The new application displays on the Manage page.