BambooHR - Suspend Employee
  • 28 Jan 2024
  • 2 Minutes to read
  • Dark
    Light
  • PDF

BambooHR - Suspend Employee

  • Dark
    Light
  • PDF

Article summary

BambooHR - Suspend Employee deactivates the BambooHR account for:

  • Assets that match the results of the selected saved query and match the Enforcement Action dynamic statement, if defined, or assets selected on the relevant asset page.

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.
  • 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 BambooHR adapter - Select this option to use the BambooHR connected adapter credentials.
    • When you select this option, the Select Adapter Connection dropdown is available, and you can choose which adapter connection to use for this Enforcement Action.
Note:

To use this option, you must successfully configure a BambooHR adapter connection.

Required Fields

These fields must be configured to run the Enforcement Set.


Additional Fields

Connection Parameters

If Use stored credentials from BambooHR adapter is disabled, these fields are required:

  • BambooHR Subdomain - The BambooHR Subdomain value is used to log into your BambooHR instance. For example, if your BambooHR instance is mycompany.bamboohr.com, specify "mycompany".

  • API Key - To get the API key value, go to https://<your_subdomain>.bamboohr.com/settings/permissions/api.php and create a new key. If you do not have permission to do so, contact your BambooHR administrator.

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

  • Fetch users from endpoint - From the dropdown, select the endpoint from which to fetch users.

    • Reports/Custom - Select users from custom reports. Recommended. Refer to Custom report API for information.
    • Employees/Directory - Select users from the employees directory.
Note:
As these parameters are customer specific, Axonius does not validate them. You must make sure the provided values are correct. Otherwise, the request might fail.


APIs

Axonius uses the Get Employee API.

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




Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.