- 22 Jan 2023
- 2 Minutes to read
- Print
- DarkLight
- PDF
Okta - Add or Remove Users to/from Group
- Updated on 22 Jan 2023
- 2 Minutes to read
- Print
- DarkLight
- PDF
Okta - Add or Remove Users to/from Group adds or removes each user retrieved from the saved query supplied as a trigger (or users selected in the asset table) to an Okta group.
See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.
General Settings
- Enforcement Set name (required) - The name of the Enforcement Set. A default value is added by Axonius. You can change the name according to your needs.
- Add description - Click to add a description of the Enforcement Set. It is recommended to describe what the Enforcement Set does.
- Run action on assets matching following query (required) - Select an asset category and a query. The Enforcement Action will be run on the assets that match the query parameters.
- A query only returns results for the asset type it was created for.
- Not all asset categories are supported for all Enforcement Actions.
- See Actions supported for Activity Logs, Adapter Fetch History and Asset Investigation Modules
- See Actions supported for Vulnerabilities.
- See Actions supported for Software.
- Action name (required) - The name of the Main action. A default value is added by Axonius. You can change the name according to your needs.
- 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 the first connected Okta adapter credentials.
To use this option, you must successfully configure an Okta adapter connection.
Required Fields
These fields must be configured to run the Enforcement Set.
- Group Member Operation - Select the operation to perform either 'Add User To Group' or 'Remove User From Group'
- Group Name - the name of the group to which the user will be added or removed from.
- Instance Name - 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.
Okta URL - The hostname or IP address of the Okta server. This field format is '[instance].okta.com'.
Okta API Key - An API key, created in the admin panel. For details, see Creating an API Token in Okta.
Number of parallel requests (default: 75) - Specify the maximum parallel requests that will be created when connecting to the value supplied in Okta URL.
API rate limit threshold 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.
HTTPS Proxy - A proxy to use when connecting to the value supplied in Okta URL.
If Use stored credentials from the Okta adapter is not enabled, the fields above are required.
- Tunnel Name - For Axonius-hosted (SaaS) deployments. Select the tunnel through which to connect to perform the action.
APIs
Axonius uses the Okta Groups API.
Permissions
The value supplied in Okta API Key must have write or admin permissions
For more details about other Enforcement Actions available, see Action Library.