Skip to main content

Add the Okta connector in Axiad Mesh

This is the second half of the Okta integration. Complete Set up Okta for Axiad Mesh first — you need the credential from it before you start here.

Before you begin​

Have these ready:

  • Your Okta org URL, over HTTPS — for example https://acme.okta.com.
  • A Mesh administrator account with permission to manage connectors.
  • The credential for the method you chose in Okta:
If you set upHave ready
An API tokenThe token value
An OAuth service appThe Client ID and the private key
The wizard collects an API token

The setup wizard below authenticates with an Okta API token. If you created an OAuth service app instead, contact Axiad — wizard support for it is being added.

Open the wizard​

In the Mesh portal, go to Settings → Connectors and select Add connector.

The Connectors page in Mesh settings, with the Add connector button in the top right

Choose Okta Workforce Identity under Guided setup.

The Add connector dialog, with Okta Workforce Identity listed under Guided setup

Several Okta entries look alike — pick the right one

Mesh lists more than one Okta connector, and they are not interchangeable.

EntryUse it?
Okta Workforce IdentityYes — this guide, under Guided setup
OktaNo. A different, earlier connector
Okta Single-sign-onNo. A different, earlier connector
Okta Single-sign-on (Legacy)No. An earlier connector kept for existing setups

Choosing any of the others gives you a different form and a different set of fields.

Setting this up with the AI assistant

Set up with AI assistant does not cover Okta Workforce Identity today. Use Guided setup.

The wizard has five steps — Identify, Authenticate, Collect, Tuning and Review. The rail on the left tracks where you are and summarizes each finished step. Steps ahead of an incomplete one stay locked until you can reach them.

Step 1 — Identify​

Enter a display name for the connector and your Okta org URL.

The URL must be HTTPS on an Okta domain: .okta.com, .oktapreview.com, .okta-emea.com, or .okta-gov.com. No path, no query string.

Step 1, Identify, with the Connector name and Okta org URL fields and the fixed-after-creation notice

The org URL is fixed after creation

The org URL identifies the source of everything Mesh ingests through this connector, so it cannot be changed later. Check it before you continue. To read a second Okta org, add a second connector.

The display name is only a label — it appears in the connector list and in reports, and you can change it whenever you like.

Step 2 — Authenticate​

Paste the API token into Okta API token.

Step 2, Authenticate, with the Okta API token field

Paste the token exactly as Okta issued it. Mesh sends it as Authorization: SSWS, the scheme Okta's Management API requires, so the value needs no prefix of its own. There is no client ID to enter: an API token carries its own identity. Mesh encrypts the token at rest and never shows it again — after saving, only a short fingerprint of it is displayed.

Select Test connection. You cannot continue until the test passes. Changing the token clears a previous pass, and you have to test again.

A pass shows a green Connected banner and unlocks Continue. It means Okta accepted the credential — it does not mean every endpoint returns data. That is checked by the sample read on step 5.

If the test fails, the wizard says which kind of failure it was:

ErrorMeaningWhat to do
AuthenticationOkta rejected the credentialsCheck the value, and confirm the token has not been revoked or expired
AuthorizationThe token is valid, but the account that created it cannot read what Mesh needsAn API token inherits its creator's permissions, so confirm that account has the Read-only Administrator role in Okta, then test again. Nothing on this step is wrong
CommunicationMesh could not reach the Okta orgRe-check the org URL on step 1
ConfigurationThe org slug is not valid yetEnter a valid Okta org slug before testing
SystemThe test could not be completedNothing you entered is wrong. Try again, and contact Axiad if it keeps happening

Step 3 — Collect​

Choose what Mesh reads. Endpoints are grouped by domain — Directory, Applications, Security — and each row shows the Okta API path it calls, so you can see exactly what a selection means. The checkbox on a domain header selects or clears that whole domain.

Step 3, Collect, with the endpoint groups Directory, Applications and Security all selected

Your selection is saved with the connector and applied on its next run — endpoints you clear are not called. Leave everything selected unless you have a reason not to; clearing an endpoint removes the data it feeds, and anything Mesh derives from that data goes with it.

The seventeen endpoints​

Directory — 7 endpoints

EndpointWhat it readsOkta API path
UsersProfiles, status, and lifecycle state/api/v1/users
GroupsGroup objects and descriptions/api/v1/groups
Group membersUser-to-group memberships/api/v1/groups/{groupId}/users
Authenticator enrollmentsUser authenticator enrollment records/api/v1/users/{userId}/authenticator-enrollments
OrganizationsUsers grouped by organization/api/v1/users
DepartmentsUsers grouped by department/api/v1/users
DivisionsUsers grouped by division/api/v1/users

Applications — 5 endpoints

EndpointWhat it readsOkta API path
ApplicationsApp integrations in the org/api/v1/apps
PoliciesApplication policy records/api/v1/apps
ServicesApplication service records/api/v1/apps
ResourcesApplication resource records/api/v1/apps
User policiesApplication user policy links/api/v1/apps/{appId}/users

Security — 5 endpoints

EndpointWhat it readsOkta API path
System logOrg-wide security and audit events/api/v1/logs
Group membership changesGroup membership change events/api/v1/logs
Application membership changesApplication membership change events/api/v1/logs
User lifecycle changesUser deletion and deactivation events/api/v1/logs
Group lifecycle changesGroup creation and deletion events/api/v1/logs
Seventeen endpoints, seven Okta API paths

Several endpoints read the same Okta path with a different query — the three Directory groupings all read /api/v1/users, and the five Security endpoints all read /api/v1/logs. That is why Set up Okta lists seven paths and four scopes while this step lists seventeen endpoints. Both are describing the same thing.

Step 4 — Tuning​

Optional. Every setting on this step has a default that works, so you can accept them all and move on.

Step 4, Tuning, with the sync frequency, request rate and retry options

SettingDefaultWhen to change it
How often should Mesh read?Every hourEvery 15 minutes to see joiners and leavers sooner; twice a day to keep API load low
Request rateStandard — 10 requests a second, 4 at onceGentle if your Okta org already throttles, or if other integrations share the tenant; Fast only on a higher-tier Okta plan
If Okta stops respondingKeep trying — 5 attemptsGive up quickly if you would rather see a failure reported sooner than have the run ride out an Okta incident
Records per request100Smaller pages on slow links, larger pages for a big org

This is also where the sync frequency lives — not on the Collect step.

Step 5 — Review​

The wizard runs a sample read against your org and reports what it found for each category, then summarizes the configuration you are about to create.

Step 5, Review and create, with per-category sample read results and the configuration summary

Read the per-category results before you create the connector. A SUCCESS row with a record count means Mesh reached that endpoint and Okta returned data. A FAILURE row names the reason — in the frame above the System log read came back http 429 Too Many Requests, which is Okta rate-limiting the org rather than anything wrong with the configuration.

Select Run sample again to retry after fixing something, or Create connector to finish. Creating the connector closes the wizard.

If a category returns far fewer records than you expect

This is almost always the Okta admin role, not the connector. A token can hold the right scopes and still see only part of the org. Go back to Set up Okta and confirm the account behind the token has the Read-only Administrator role, with resource sets set to All.

Managing the connector​

Back on the connector list, each row shows the provider, health and sync status — see Read the Connectors page. The Status toggle enables or disables scheduled collection.

The row menu holds the rest:

The connector row menu, showing View collections, Logs and Edit

ActionWhat it does
View collectionsLast and next run, sync stage, and record counts per data type. See Collected data
LogsCollection run history
EditChange the configuration — everything except the org URL
There is no manual run for this connector

Okta Workforce Identity collects on the schedule you set on the Tuning step. To collect sooner, set a shorter frequency in Edit.

Credentials are never shown again

Once saved, the token is displayed only as a fingerprint. If you lose the original value, create a new token in Okta and update the connector.

Verify the collection​

  1. Open View collections and confirm the first collection completed.
  2. Compare the collected user and group counts against your Okta org.

A collection that finishes but returns noticeably fewer records than your org holds is usually a permission problem rather than a connection problem — see the next section.

Troubleshooting​

SymptomLikely causeWhat to do
Test connection fails with an authentication errorThe token is wrong, revoked, or expiredIssue a fresh token in Okta and paste it again
Test connection fails with a communication errorThe org URL is wrong or not reachableRe-check the URL on step 1
A category on step 5 reports http 429 Too Many RequestsOkta is rate-limiting the orgRe-run the sample, or set Request rate to Gentle on step 4
Collection completes, but far fewer records than expectedThe token's account has the right scopes but no admin role, or a custom role bound to a narrowed resource setAssign Read-only Administrator, and set every resource set to All
Users and groups arrive, but no sign-in eventsokta.logs.read was not granted, or a custom admin role is in use and cannot read the System LogGrant the scope, and switch to the standard Read-only Administrator role
Authentication fails from a token that worked beforeThe token is IP-restricted and Mesh's addresses changed, or the token expiredConfirm the IP zone with Axiad support, or issue a new token
Collection is slower than expectedOkta is rate-limiting your orgNo action needed. Mesh reads Okta's rate-limit headers and slows itself before hitting a limit, then retries.
The org URL is wrong and Edit will not let you change itThe org URL is fixed once the connector existsCreate a new connector with the correct URL, then disable the old one

If a problem persists, contact Axiad support with the connector name, the time of the failed collection, and the step the wizard stopped on.