Getting Started

Owned by Vincent Mutambuki
Last updated: Jan 10, 2024
3 min read

Getting started

API Authentication Setup

To start, you will need Okta API credentials from your Organization Okta Account. You will need 

  • User Token

  • URL to your okta instance. 

Both pieces of information can be found in Okta admin. Navigate to Security > API. 

  • Copy the Issuer URI.

  • Navigate to the token tab and generate a new token. Copy the new token.

Both pieces of information will be needed in the next step. 

 

Next enter the information in Okta API Credentials area of Okta Profiles and validate the information.

 

OAuth2 Authentication

Step 1: General Settings

  1. Navigate to your Okta Dashboard.

  2. Go to Applications and select the application you wish to configure.

  3. Under the General Settings, configure the Application section as follows:

    • Application type: Web

    • Grant type: Make sure to enable both Authorization Code and Refresh Token.

Step 2: Refresh Token

Within the same General Settings:

  1. Scroll to the Refresh Token section.

  2. Select Use persistent token to ensure that the refresh tokens are long-lived.

Step 3: Login Redirection

  1. Under the Login section, locate the Sign-in redirect URIs.

  2. Add your specific redirect URI. For JIRA integrations, it typically looks like this:

    <JIRA_URL>/plugins/servlet/ac/com.mumosystems.okta-profiles/connection-page

     

    Ensure that you replace <JIRA_URL> with your actual JIRA instance URL.

  3. If your application setup requires, enable the option to Allow wildcard * in login URI redirect.

Step 4: Okta API Scopes

  1. Scroll to the Okta API Scopes section.

  2. Grant the following scopes by ensuring they are set to Granted:

    • okta.users.read

    • okta.users.manage

    • okta.eventHooks.read

    • okta.eventHooks.manage

    • okta.groups.read

    • okta.groups.manage

    • okta.schemas.read

    These scopes control which API endpoints the application can access and what operations it can perform.

  1. In the User Consent section, select Require consent.

  2. Provide the Terms of Service URI, Policy URI, and Logo URI if necessary.

Step 6: Finalizing Setup

After completing the configuration:

  1. Review all settings to ensure they are correct.

  2. Click Save to apply the changes.

Step 7: Reviewing Granted Scopes

  1. In the Okta API Scopes tab, verify that all required scopes have been granted.

  2. If any scopes are missing, grant them accordingly.

Step 8: Activation and Testing

  1. Ensure that the application status is set to Active.

  2. Test the integration to confirm that the OAuth flow is functioning as expected. This can be done by attempting to sign in through the integration and checking for successful redirection and authentication.

 

Back in Jira, enter same api URL from Okta above. Then paste the client ID and Client secret. Make sure to validate then sync the data.

 

Synchronize Data

Synchronize the users. This might take a while depending on the amount of users you are synchronizing. Once this is done, you will have a user directory of all Okta users that match users in Jira.