Okta - Remove Users from Groups
  • 14 Nov 2024
  • 3 Minutes to read
  • Dark
    Light
  • PDF

Okta - Remove Users from Groups

  • Dark
    Light
  • PDF

Article summary

Okta - Remove Users from Groups removes a user from all groups except the default Okta group called "Everyone", and those in the exclude list, for:

  • Assets returned by the selected query or assets selected on the relevant asset page.

See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.

Note:

Required Fields

These fields must be configured to run the Enforcement Set.

  • Action name - The name of this Enforcement Action. The system sets a default name. You can change the name.
  • Configure Dynamic Values - Toggle on to enter a Dynamic Value statement. See Creating Enforcement Action Dynamic Value Statements to learn more about Dynamic Value statement syntax.

  • Use stored credentials from the Okta Adapter - Select this option to use credentials from the adapter connection. By default, the first connection is selected.

    • When you select this option, the Select Adapter Connection drop-down becomes available. Select the adapter connection to use for this Enforcement Action.
    Note:

    To use this option, you must successfully configure an Okta adapter connection.

  • Compute Node - The Axonius node to use when connecting to the specified host. For more details, see Connecting Additional Axonius Nodes.

Additional Fields

These fields are optional.

  • Exclude groups - Users will be removed from all groups except for the "Everyone" group and the groups selected here.

  • Okta URL - The hostname or IP address of the Okta server. This field format is '[instance].okta.com'.

  • Authentication - The type of authentication to use.

  • Okta API Key (Access via API Token) - An API key, created in the admin panel. For details, see Creating an API Token in Okta.

  • Okta Client ID (Access via OAuth2) - Client ID of the service app. This is required when OAuth2 is selected in the Authentication drop-down.

  • Okta JWK Private/Public Keys - The JSON web key which was generated and assigned in the OAuth 2.0 service app integration in the Admin Console of Okta. This is required when OAuth2 is selected in the Authentication drop-down.

  • Throttling rate percentage (default: 10) - Specify the threshold percentage of the Okta API rate limit when connecting to the value supplied in Okta URL. Axonius will stop the data fetch when the API rate limit reaches the supplied value.

  • Number of parallel requests (default: 75) - Specify the maximum parallel requests that will be created when connecting to the value supplied in Okta URL.

  • Admin URL - The hostname or IP address of the Okta admin server. This field format is '[instance]-admin.okta.com'.

  • Admin Username - The value you enter in the User Name field in Okta for the new user you created to allow Axonius to fetch SaaS Management data.

  • Admin Password - The password you set for the new user in Okta.

  • 2FA Secret Key - The secret generated in Okta for setting up 2-factor authentication for the Okta user created for collecting SaaS Management data.

  • SSO Provider - If your organization uses Okta for SSO, you can set this select this check box (selected by default). For more information, see Connecting your SSO Solution Provider Adapter.

  • Department Field (default: department) - This is the mapping of the department value for the Okta authentication object. Check if your organization's 'department' value is different from the default value ('department').

  • User Filter Params - You can use the Okta Expression language to filter a subset of users (for example, users who belong to specific departments) to be retrieved by the Okta adapter and displayed in Axonius.

  • Filters users by group name - Enter a group name to only fetch users from the specific group. Refer to Configuring a Group in Okta for details.

  • Add users inside the devices - Select this option to fetch the devices with the users.

  • HTTPS Proxy (optional) - Connect the adapter to a proxy instead of directly connecting it to the domain.

  • Gateway Name - Select the Gateway through which to connect to perform the action.

APIs

Axonius uses the Core Okta API.

Permissions

The value supplied in Okta API Key must have write or admin permissions.

Required Ports

Axonius must be able to communicate with the following ports:

  • TCP port 443
  • TCP port 80

Version Matrix

This adapter has only been tested with the versions marked as supported, but may work with other versions. Please contact Axonius Support if you have a version that is not listed and it is not functioning as expected.

VersionSupportedNotes
Okta 4.5Yes

For more details about other Enforcement Actions available, see Action Library.


Was this article helpful?