- 09 Jul 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Freshservice - Add or Remove User from Group
- Updated on 09 Jul 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Freshservice - Add or Remove User from Group adds or removes users from groups in Freshservice for assets retrieved from the saved query supplied as a trigger (or from the assets selected in the asset table).
All Freshservice field names are case sensitive. To check a field name, fetch the asset with a curl command and check the RAW data in Axonius. See Service Desk API for Developers | Freshservice.
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 - 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, Adapters 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 Freshservice adapter - Select this option to use the first connected Freshservice adapter credentials.NOTE
- To use this option, you must successfully configure a Freshservice adapter connection.
- The API key used for the adapter connection must be for a user with permissions to modify groups.
Required Fields
These fields must be filled in to run the Enforcement Set.
- Group IDs (comma separated) - Enter a comma separated list of group IDs. The users will be added or removed from the identified groups.
- Add/Remove assignment - Select the action to perform.
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.
Connection Parameters
If Use stored credentials from the Freshservice adapter is disabled, these fields are required:
- Freshservice domain - The hostname or IP address of the Freshservice server.
- API Key – Specify the API Key provided by Freshservice.
- Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.
- HTTPS Proxy - Connect the adapter to a proxy instead of directly connecting it to the domain.
- Throttle API Requests - Select this option to only use 90% of the API total rate limit bandwidth. For example: If a customer has 3000 total API calls allowed per hour, axonius will only produce 2700 calls, and leave the remaining 10% available.
For more details about other Enforcement Actions available, see Action Library.