Okta v2

Integration with Okta's cloud-based identity management service.

Authentication & Identity Management · Okta

Configuration parameters

  • url — Okta URL (https://<domain>.okta.com) (required)
  • credentials —
  • apitoken — API Token
  • use_oauth — Use OAuth 2.0 Authentication
  • client_id — Client ID
  • private_key — Private Key
  • jwt_algorithm — JWT Signing Algorithm
  • key_id — Key ID
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (35)

  • okta-activate-user

    Activates a single user.

  • okta-add-to-group

    Adds a user to a group with OKTA_GROUP type.

  • okta-assign-group-to-app

    Assign a group to an application.

  • okta-auth-reset

    Reset OAuth authentication data (authentication process will start from the beginning, and a new token will be generated).

  • okta-clear-user-sessions

    Removes all active identity provider sessions. This forces the user to authenticate upon the next operation. By default, OpenID Connect and OAuth refresh and access tokens issued to the user are revoked. Token revocation can be disabled if needed. For more information and examples: https://developer.okta.com/docs/reference/api/users/#user-sessions

  • okta-create-group

    Create a new group in Okta tenant.

  • okta-create-user

    Creates a new user with an option of setting a password, recovery question, and answer. The new user will immediately be able to log in after activation with the assigned password. This flow is common when developing a custom user registration experience.

  • okta-create-zone

    Creates a Zone with the specified name.

  • okta-deactivate-user

    Deactivates a single user.

  • okta-delete-user

    Deletes the specified user.

  • okta-expire-password

    Expires a password for an existing Okta user.

  • okta-get-application-assignments

    Returns events for when a user was assigned to an application.

  • okta-get-application-authentication

    Returns logs using specified filters.

  • okta-get-failed-logins

    Returns failed login events.

  • okta-get-group-assignments

    Gets events for when a user was added to a group.

  • okta-get-group-members

    Enumerates all users that are members of a group.

  • okta-get-groups

    Returns all user groups associated with a specified user.

  • okta-get-logs

    Gets logs by providing optional filters.

  • okta-get-user

    Fetches information for a single user. You must enter one or more parameters for the command to run.

  • okta-get-user-factors

    Returns all the enrolled factors for the specified user.

  • okta-get-zone

    Get a Zone by its ID.

  • okta-list-groups

    Lists groups in your organization. A subset of groups can be returned that match a supported filter expression or query.

  • okta-list-users

    Lists users in your organization.

  • okta-list-zones

    Get an Okta Zone object.

  • okta-remove-from-group

    Removes a user from a group with OKTA_GROUP type.

  • okta-reset-factor

    Un-enrolls an existing factor for the specified user. This enables the user to enroll a new factor.

  • okta-search

    Searches for Okta users.

  • okta-set-password

    Sets passwords without validating existing user credentials.

  • okta-suspend-user

    Suspends a single user. This operation can only be performed on users with an ACTIVE status. After the porcess is completed, the user's status is SUSPENDED.

  • okta-unlock-user

    Unlocks a single user.

  • okta-unsuspend-user

    Returns a single user to ACTIVE status. This operation can only be performed on users that have a SUSPENDED status.

  • okta-update-user

    Updates a user with a given login. All fields are optional. Fields which are not set, will not be overwritten.

  • okta-update-zone

    Update an Okta Zone.

  • okta-verify-mfa-status

    Checks the status of the push factor mfa.

  • okta-verify-push-factor

    Enrolls and verifies a push factor for the specified user.