> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Okta Preview
## Overview
## Pre-built tooling
| Tools | Status |
| ------------------------------- | ------ |
| Pre-built authorization (OAuth) | ✅ |
| Credentials auto-refresh | ✅ |
| Auth parameters validation | ✅ |
| Pre-built authorization UI | ✅ |
| Custom authorization UI | ✅ |
| Expired credentials detection | ✅ |
| Tools | Status |
| ----------------------------------------- | ------------------------------ |
| Pre-built integrations | ✅ |
| API unification | ✅ |
| 2-way sync | ✅ |
| Webhooks from Nango on data modifications | ✅ |
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
| Proxy requests | ✅ |
| Tools | Status |
| ----------------------- | ------ |
| HTTP request logging | ✅ |
| End-to-end type safety | ✅ |
| Data runtime validation | ✅ |
| OpenTelemetry export | ✅ |
| Slack alerts on errors | ✅ |
| Integration status API | ✅ |
| Tools | Status |
| ---------------------------------- | ------ |
| Create or customize use-cases | ✅ |
| Pre-configured pagination | ✅ |
| Pre-configured rate-limit handling | ✅ |
| Per-customer configurations | ✅ |
### Others
| Function name | Description | Type | Source code |
| ----------------------------------- | ----------------------------------------------------------------- | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| `activate-application` | Activate an application. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/activate-application.ts) |
| `activate-group-rule` | Activate a group membership rule so it starts evaluating users. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/activate-group-rule.ts) |
| `activate-user` | Activate a user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/activate-user.ts) |
| `add-group` | Create a group. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/add-group.ts) |
| `add-user-group` | Add a user to a group | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/add-user-group.ts) |
| `assign-group-to-application` | Assign a group to an application. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/assign-group-to-application.ts) |
| `assign-role-to-user` | Assign an admin role to a user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/assign-role-to-user.ts) |
| `assign-user-to-application` | Assign a user to an application. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/assign-user-to-application.ts) |
| `create-application` | Create an application (e.g. a bookmark app for basic SSO tiles) | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/create-application.ts) |
| `create-authorization-server-scope` | Create a custom OAuth scope on an authorization server | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/create-authorization-server-scope.ts) |
| `create-group-rule` | Create a group membership rule. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/create-group-rule.ts) |
| `create-policy-rule` | Create a rule under a policy. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/create-policy-rule.ts) |
| `create-policy` | Create a policy. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/create-policy.ts) |
| `create-user` | Create a user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/create-user.ts) |
| `deactivate-application` | Deactivate an application. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/deactivate-application.ts) |
| `deactivate-user` | Deactivate a user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/deactivate-user.ts) |
| `delete-application` | Delete an application. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/delete-application.ts) |
| `delete-authorization-server-scope` | Delete a custom OAuth scope from an authorization server. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/delete-authorization-server-scope.ts) |
| `delete-factor` | Unenroll (delete) a factor from a user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/delete-factor.ts) |
| `delete-group-rule` | Delete a group membership rule. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/delete-group-rule.ts) |
| `delete-group` | Delete a group. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/delete-group.ts) |
| `delete-policy` | Delete a policy. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/delete-policy.ts) |
| `delete-user` | Permanently delete a deactivated user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/delete-user.ts) |
| `enroll-factor` | Enroll a factor for a user | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/enroll-factor.ts) |
| `expire-password` | Expire a user's current password, forcing a change on next login. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/expire-password.ts) |
| `get-application` | Retrieve an application. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/get-application.ts) |
| `get-authorization-server` | Retrieve an authorization server | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/get-authorization-server.ts) |
| `get-factor` | Retrieve a single enrolled factor for a user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/get-factor.ts) |
| `get-group` | Retrieve a group. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/get-group.ts) |
| `get-policy` | Retrieve a policy. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/get-policy.ts) |
| `get-user-schema` | Retrieve the JSON schema for a user type. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/get-user-schema.ts) |
| `get-user` | Retrieve a user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/get-user.ts) |
| `list-application-groups` | List groups assigned to an application. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-application-groups.ts) |
| `list-application-users` | List users assigned to an application | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-application-users.ts) |
| `list-applications` | List applications | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-applications.ts) |
| `list-authenticators` | List the authenticator types configured at the org level. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-authenticators.ts) |
| `list-authorization-server-claims` | List the token claims defined on an authorization server. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-authorization-server-claims.ts) |
| `list-authorization-server-scopes` | List the OAuth scopes defined on an authorization server. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-authorization-server-scopes.ts) |
| `list-authorization-servers` | List authorization servers. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-authorization-servers.ts) |
| `list-factor-catalog` | List the factor types available for a specific user to enroll. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-factor-catalog.ts) |
| `list-factors` | List enrolled factors for a user | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-factors.ts) |
| `list-group-applications` | List applications assigned to a group. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-group-applications.ts) |
| `list-group-roles` | List the admin roles assigned to a group. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-group-roles.ts) |
| `list-group-rules` | List group membership rules. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-group-rules.ts) |
| `list-group-users` | List users in a group | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-group-users.ts) |
| `list-groups` | List groups. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-groups.ts) |
| `list-policies` | List policies of a given type. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-policies.ts) |
| `list-policy-rules` | List the rules under a policy | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-policy-rules.ts) |
| `list-system-log` | List system log events. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-system-log.ts) |
| `list-user-groups` | List the groups a user belongs to. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-user-groups.ts) |
| `list-user-roles` | List the admin roles assigned to a user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-user-roles.ts) |
| `list-user-types` | List user types/schemas. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-user-types.ts) |
| `list-users` | List users. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/list-users.ts) |
| `remove-group-from-application` | Unassign a group from an application. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/remove-group-from-application.ts) |
| `remove-role-from-user` | Remove an admin role assignment from a user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/remove-role-from-user.ts) |
| `remove-user-from-application` | Unassign a user from an application. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/remove-user-from-application.ts) |
| `remove-user-group` | Remove a user from a group | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/remove-user-group.ts) |
| `reset-password` | Generate a one-time password reset token/link for a user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/reset-password.ts) |
| `suspend-user` | Suspend an active user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/suspend-user.ts) |
| `unlock-user` | Unlock a user with a LOCKED\_OUT status. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/unlock-user.ts) |
| `unsuspend-user` | Return a suspended user to ACTIVE. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/unsuspend-user.ts) |
| `update-group` | Update a group. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/update-group.ts) |
| `update-user-schema` | Add or update a custom attribute on a user schema. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/update-user-schema.ts) |
| `update-user` | Update a user. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/actions/update-user.ts) |
| `application-users` | Sync application assignments | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/syncs/application-users.ts) |
| `applications` | Sync applications. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/syncs/applications.ts) |
| `authorization-servers` | Sync authorization servers. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/syncs/authorization-servers.ts) |
| `factors` | Sync user factors. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/syncs/factors.ts) |
| `group-memberships` | Sync group membership | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/syncs/group-memberships.ts) |
| `groups` | Sync groups. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/syncs/groups.ts) |
| `policies` | Sync policies. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/syncs/policies.ts) |
| `role-assignments` | Sync admin role assignments for users and groups. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/syncs/role-assignments.ts) |
| `schemas` | Sync user schemas/types. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/syncs/schemas.ts) |
| `system-log-events` | Sync system log events. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/syncs/system-log-events.ts) |
| `users` | Sync users. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/okta/syncs/users.ts) |
## Access requirements
| Pre-Requisites | Status | Comment |
| ----------------- | ------ | ------- |
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ | |
## Setup guide
*No setup guide yet.*
Need help getting started? Get help in the [community](https://nango.dev/slack).
Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/okta-preview.mdx)
## Useful links
* [How to register an Application](https://developer.okta.com/docs/guides/implement-oauth-for-okta/main/#create-an-oauth-2-0-app-in-okta)
* [OAuth-related docs](https://developer.okta.com/docs/reference/api/oidc)
* [List of OAuth scopes](https://developer.okta.com/docs/api/oauth2/#oauth-20-scopes)
* [API rate limiting](https://developer.okta.com/docs/reference/rate-limits/)
Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/okta-preview.mdx)
## API gotchas
* To get refresh\_token, you will need to add **`offline_access`** to the list of your scopes.
Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/okta-preview.mdx)