

Using Okta as an External IDP with OIDC

Follow the instructions below to connect Okta as a third-party Identity Provider to WSO2 API Manager.

Prerequisites

Before you begin, make sure you do the following.

1. Create an account in https://developer.okta.com/
2. Download the WSO2 API Manager distribution from https://wso2.com/api-management/.

3. Enable the email domain on WSO2 API Manager.

   You need to enable this because Okta uses the email as the username by default. As the email domain is not enabled by default, you have to enable it to use the email as the username in WSO2 API Manager. Once enabled, you can use your email or a normal username as your username.

   Follow the instructions below:

   1. Unzip the WSO2 API Manager distribution.
   2. Open the deployment.toml file, which is located in the <API-M_HOME>/repository/conf/ directory.

   3. Add the following configuration.

      [tenant_mgt]
      enable_email_domain= true

4. Start the WSO2 API Manager server.

Step 1 - Configure Okta

Note

For more information on working with the Okta Admin Portal, see the official Okta documentation.

1. Navigate to the Okta Admin Portal.

2. Add an application in Okta.

   Select Web as the platform type of the application and create an application based on the following application settings.

   Field	Value
   Name	oidc_app
   Base URIs	Let's not add a new base URI
   Login Redirect URIs	https://localhost:9443/commonauth
   Logout Redirect URIs	https://localhost:9443/commonauth
   Group Assignments	Everyone
   Grant type allowed	Authorization Code

3. Add an attribute to the default user profile.

   Add a new attribute, with the following details, to the default user profile of Okta to represent the user role.

   Field	Value
   Data Type	String
   Display Name	Role
   Variable Name	role
   Description
   Attribute Length	Between
   min
   max

4. Add the claims that need to be returned from the ID Token in Okta.

   These claims will be used to map the user details with WSO2 API Manager for authentication and authorization purposes.

   Let's add two claims that have the following details.

   Claim 1

   Field	Value
   Name	wso2user
   Include in token type	ID Token Always
   Value Type	Expression
   Value	user.login
   Include in	The following scopes: openid

   Claim 2

   Field	Value
   Name	roles
   Include in token type	ID Token Always
   Value Type	Expression
   Value	user.login
   Include in	The following scopes: openid

5. Add a role to the provisioned user in Okta.

   This will enable WSO2 API Manager to map an internal role to the provisioned user. Edit the provisioned user's profile and add any as the Role.

Step 2 - Configure API Manager

1. Sign in to the WSO2 API-M Management Console.

   https://localhost:9443/carbon.

2. Create a role that needs to be assigned to users that will be provisioned from Okta.

   1. Click Main, Identity, and then click Add under Users and Roles.

   2. Click Add New Role.

      

   3. Add a new role based on the following details and click Finish.

      Field	Value
      Domain	Primary
      Role Name	okta_role

      

3. Add scope mapping via the WSO2 API Manager Admin Portal.

   1. Sign in to the WSO2 API Manager Admin Portal.

      https://localhost:9443/admin

   2. Click Settings and then click Scope Assignments.

      

   3. Click Add Scope Mappings.

      

   4. Enter okta_role as the role name and click Next.

      

   5. Go to Select permissions, click Custom permissions, and start assigning the permissions as shown below.

      These permissions will allow a user having the okta_role to log in to the Publisher and the Developer Portal.

      Hiererchy	Permissions
      admin	View throttling policies apim:tier_view Retrieve and publish Monetization related usage records apim:monetization_usage_publish
      publisher	Create threat protection policies apim:threat_protection_policy_create Update and delete mediation policies apim:mediation_policy_manage Update and delete backend endpoint certificates apim:ep_certificates_update View backend endpoint certificates apim:ep_certificates_view Publish API apim:api_publish Update and delete client certificates apim:client_certificates_update Generate Internal Key apim:api_generate_key View API apim:api_view Create mediation policies apim:mediation_policy_create Get/ subscribe/ configure publisher alerts apim:pub_alert_manage Update and delete API documents apim:document_manage Read permission to comments apim:comment_view Write permission to comments apim:comment_write Create API documents apim:document_create Update and delete threat protection policies apim:threat_protection_policy_manage View Subscription apim:subscription_view Create API apim:api_create Add client certificates apim:client_certificates_add Delete API apim:api_delete View client certificates apim:client_certificates_view Retrieve store settings apim:publisher_settings Block Subscription apim:subscription_block View mediation policies apim:mediation_policy_view Add backend endpoint certificates apim:ep_certificates_add
      devportal	Retrieve, Manage applications apim:app_manage Retrieve Developer Portal settings apim:store_settings Retrieve, subscribe and configure Developer Portal alert types apim:sub_alert_manage Generate API Keys apim:api_key Retrieve, Manage subscriptions apim:sub_manage Subscribe API apim:subscribe

      

   6. Click Save to save your changes.

4. Add an Identity Provider.

   1. Sign in to the WSO2 API-M Management Console.

      https://localhost:9443/carbon.

   2. Click Main and then click Add under Identity Providers.

   3. Enter the Identity Provider's Name.

      

   4. Expand Federated Authenticators -> OAuth2/OpenID Connect Configuration and add the following details.

      

      Field		Sample value
      Enable OAuth2/OpenIDConnect		True
      Client ID		You can find this value from the Okta application that you created.
      Client Secret		You can find this value from the Okta application that you created.
      Authorization Endpoint URL		https://your_okta_url/oauth2/default/v1/authorize
      Token Endpoint URL		https://your_okta_url/oauth2/default/v1/token
      Callback URL		https://localhost:9443/commonauth
      Userinfo Endpoint URL		https://your_okta_url/oauth2/default/v1/userinfo
      Logout Endpoint URL		https://your_okta_url/oauth2/default/v1/logoutcode>
      Additional Query Parameters		scope=openid profile

   5. Expand Claim Configuration -> Basic Claim Configuration.

      Add the claim configurations as shown in the image below.

      

   6. Expand Role configuration and add okta_role as shown below.

      You can check if the user logged in has the role any and assign the local okta_role.

      

   7. Enable Just-in-Time Provisioning for the user to be saved in the API Manager user store.

      

   Info

   When Just-In-Time Provisioning is enabled, the user details will be saved in the API Manager user store. User profile details will be updated via the federation following each login event. To preserve the user profile details without any changes, you need to enable SystemRolesRetainedProvisionHandler.

   Add the following to the <API-M_HOME>/repository/conf/deployment.toml file and restart the server.

   [authentication.framework.extensions]
   provisioning_handler = "org.wso2.carbon.identity.application.authentication.framework.handler.provisioning.impl.SystemRolesRetainedProvisionHandler"

5. Update the Service Providers.

   1. Click Service Providers -> List in the WSO2 API-M Management Console.

      There are two service providers available by default; apim_publisher and apim_devportal.

   2. Click Edit to edit apim_publisher.

      Warning

      You need to have signed in to the Developer Portal and Publisher at least once for the two service providers to appear, as it is created during the first sign in.

      

   3. Expand Local & Outbound Authentication Configuration under Federated Authentication and select the identity provider you created.

      

   4. Repeat the latter mentioned two steps for apim_devportal.

      Now you will be able to Sign in to the Publisher and Developer Portal using Okta.

      

Top