Consume Okta OData Feeds in PowerBuilder
The CData API Server produces secure feeds of Okta data that you can consume in PowerBuilder DataWindows. The API Server supports the major Web services, including OData, Atom, JSON, HTML, CSV, TSV, and RSS. It also supports the major authentication schemes and SSL.
This article shows how to create a DataWindow that uses the CData API Server to retrieve data.
Set Up the API Server
Follow the steps below to begin producing secure Okta OData services:
Deploy
The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.
The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.
Connect to Okta
After you deploy the API Server, provide authentication values and other connection properties needed to connect to Okta by clicking Settings -> Connections and adding a new connection in the API Server administration console.
To connect to Okta, set the Domain connection string property to your Okta domain.
You will use OAuth to authenticate with Okta, so you need to create a custom OAuth application.
Creating a Custom OAuth Application
From your Okta account:
- Sign in to your Okta developer edition organization with your administrator account.
- In the Admin Console, go to Applications > Applications.
- Click Create App Integration.
- For the Sign-in method, select OIDC - OpenID Connect.
- For Application type, choose Web Application.
- Enter a name for your custom application.
- Set the Grant Type to Authorization Code. If you want the token to be automatically refreshed, also check Refresh Token.
- Set the callback URL:
- For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
- For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
- In the Assignments section, either select Limit access to selected groups and add a group, or skip group assignment for now.
- Save the OAuth application.
- The application's Client Id and Client Secret are displayed on the application's General tab. Record these for future use. You will use the Client Id to set the OAuthClientId and the Client Secret to set the OAuthClientSecret.
- Check the Assignments tab to confirm that all users who must access the application are assigned to the application.
- On the Okta API Scopes tab, select the scopes you wish to grant to the OAuth application. These scopes determine the data that the app has permission to read, so a scope for a particular view must be granted for the driver to have permission to query that view. To confirm the scopes required for each view, see the view-specific pages in Data Model < Views in the Help documentation.
You can then choose the Okta entities you want to allow the API Server access to by clicking Settings -> Resources.
Additionally, click Settings -> Server and change the following settings for compatibility with PowerBuilder:
- Default Format: Select XML (Atom) in the menu.
- Default Version: Select 2.0 in the menu.
Authorize API Server Users
After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default, only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.
Create a Profile for Okta
Follow the steps below to use the Database Painter tool to create a database profile for the OData API of the API Server. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.
- Click Tools -> Database Painter.
- Right-click the OData node and click New Profile.
- In the Database Profile Setup dialog, enter the following:
- Profile Name: Enter a user-friendly name for the profile.
- URI: Enter the URL to the OData endpoint of the API Server. This URL will resemble the one below:
http://MyServer:8080/api.rsc
- Supply User Id and Password: Click this option to use HTTP Basic authentication. Note that the API Server also supports Windows authentication.
- User Id: Enter the name of an user in the API Server.
- Password: Enter the authtoken of an user in the API Server.
- To view and modify a table, right-click a table and then click Edit Data -> Grid.
Using Okta Data with PowerBuilder Controls
You can use standard PowerBuilder objects to connect to OData feeds and execute queries. The following example shows how to retrieve Okta data into a DataWindow.
You can add the following code to the open method:
SQLCA.DBMS = "ODT" SQLCA.DBParm = "ConnectString='URI=http://MyServer:8080/api.rsc;UID=MyAPIUser;PWD=MyAuthtoken'"; CONNECT USING SQLCA; dw_users.SetTransObject(SQLCA); dw_users.Retrieve();