Skip to main content

Check out Port for yourself ➜ 

Okta

Loading version...

Port's Okta integration allows you to model Okta identity and access management resources in your software catalog and ingest data into them.

Supported resources UserGroup

Prerequisites​

Create an Okta API token​

  1. Log in to your Okta admin console.
  2. Navigate to Security > API > Tokens.
  3. Click Create Token.
  4. Provide a name for your token (e.g., "Port Integration").
  5. Click Create Token.
  6. Copy the generated token and save it securely.
Token Security

Store your API token securely and never share it. The token provides access to your Okta data.

Okta Domain​

Your Okta domain is the subdomain of your Okta organization URL. For example, if your Okta URL is https://dev-123456.okta.com, your domain would be dev-123456.okta.com.

Setup​

Choose one of the following installation methods: Not sure which method is right for your use case? Check the available installation methods.

Configuration​

Port integrations use a YAML mapping block to ingest data from the third-party api into Port.

The mapping makes use of the JQ JSON processor to select, modify, concatenate, transform and perform other operations on existing fields and values from the integration API.

Default mapping configuration​

This is the default mapping configuration for this integration:

Default mapping configuration (click to expand)
resources:
- kind: okta-user
  selector:
    query: 'true'
    include_groups: true
    include_applications: true
    fields: "id,status,created,activated,lastLogin,lastUpdated,profile:(login,firstName,lastName,displayName,email,title,department,employeeNumber,mobilePhone,primaryPhone,streetAddress,city,state,zipCode,countryCode)"
  port:
    entity:
      mappings:
        identifier: .id
        title: .profile.displayName // .profile.firstName + " " + .profile.lastName // .profile.login
        blueprint: '"okta-user"'
        properties:
          login: .profile.login
          email: .profile.email
          firstName: .profile.firstName
          lastName: .profile.lastName
          displayName: .profile.displayName
          title: .profile.title
          department: .profile.department
          employeeNumber: .profile.employeeNumber
          mobilePhone: .profile.mobilePhone
          primaryPhone: .profile.primaryPhone
          streetAddress: .profile.streetAddress
          city: .profile.city
          state: .profile.state
          zipCode: .profile.zipCode
          countryCode: .profile.countryCode
          status: .status
          created: .created
          activated: .activated
          lastLogin: .lastLogin
          lastUpdated: .lastUpdated
        relations:
          groups: .groups[]?.id
- kind: okta-group
  selector:
    query: 'true'
  port:
    entity:
      mappings:
        identifier: .id
        title: .profile.name
        blueprint: '"okta-group"'
        properties:
          name: .profile.name
          description: .profile.description
          type: .type
          created: .created
          lastUpdated: .lastUpdated
        relations:
          members: .users[]?.id

Monitoring and sync status​

To learn more about how to monitor and check the sync status of your integration, see the relevant documentation.

Examples​

To view and test the integration's mapping against examples of the third-party API responses, use the jq playground in your data sources page. Find the integration in the list of data sources and click on it to open the playground.

Additional examples of blueprints and the relevant integration configurations:

Webhook configuration​

The Okta integration supports real-time updates through webhooks. When using the self-hosted installation method, the integration will automatically:

  1. Create an Event Hook in your Okta organization
  2. Configure the webhook to send user and group change events
  3. Process incoming webhook events to update Port entities in real-time

Webhook events​

The integration listens for the following Okta events:

  • user.lifecycle.create
  • user.lifecycle.activate
  • user.lifecycle.deactivate
  • user.lifecycle.suspend
  • user.lifecycle.unsuspend
  • user.lifecycle.delete
  • user.account.update_profile
  • group.user_membership.add
  • group.user_membership.remove
  • group.lifecycle.create
  • group.lifecycle.delete
  • group.lifecycle.update

Limitations​

  • The integration currently supports users and groups only
  • Custom Okta attributes are not automatically mapped but can be added to the configuration
  • Webhook verification is optional but recommended for production environments

Troubleshooting​

Common Issues​

  1. Authentication Errors: Verify your Okta API token has the correct permissions and is not expired
  2. Domain Issues: Ensure your Okta domain is correctly formatted (e.g., dev-123456.okta.com)
  3. Webhook Failures: Check that your self-hosted integration is accessible from the internet for webhook delivery
  4. Rate Limiting: Okta has API rate limits; the integration handles this automatically with retries