Create an API User

  • Creating API users for third-party integrations allows you to ensure a smooth, secure, and effective process.

  • After adding an API user, you can share the generated credentials with a third party. These credentials allow the third party to communicate with your system via the API.

  • You can have up to 10 active API users at any time, but you may create as many users as needed.

  • API users do not appear in any Exports/Reports.

  • An API user is only visible in Directories for Set Rights users.

We advise recreating any API users in your system before the October 2024 release, as users created before this date will not automatically appear in the new API Users screen.

Add the API user's details

To create a API User:

  1. Sign in to IRIS HR Professional.

    Activate API functionality

  2. Go to System Tools > Utilities > Tools > System Configuration.

  3. In the Modules section, select the API checkbox

  4. Select Save.

    Create your API User

  5. Go to System Tools > Utilities > Company.

  6. Select API Users.

    The API Users option.

  7. Choose Create User.

    The New API User screen displays.

  8. Add a Name for your user which relates to the API. For example, if the integration is with Qlearsite, add Qlearsite here.

  9. Select the Active checkbox to make the user active or leave it deselected to keep the user inactive.

  10. The system auto-generates a Username and Password for the API user.

    The API User screen showing the user credentials.

  11. Select Copy Password on the pop-up and paste it somewhere for future reference.

    Ensure to copy the password, as you will no longer have access to it after closing the window.

  12. Select Close.

  13. The API user displays, showing the Status, Name, and Username.

    The details of the API user you have created.

Now that you have created the API user, you can edit its Set Rights (to determine the data the user can access), change its status, delete it from the system, or reset its password.

Edit an API User's Set Rights

  1. Set Rights Set Rights are the system permissions you allocate to employees to control the information available to a user about other employees. determine the level of access the API user has to your system's data. When creating an API user, the system grants them full Set Rights permissions, but you can change this.

    The Set Rights screen.

To update an API user's Set Rights permissions:

  1. Find the API User whose Set Rights permissions you want to edit and select the dropdown arrow.

  2. Select Edit Set Rights.

    The Edit Set Rights option.

  3. Select the Advanced option to open the API User's own rights. Update the user's Set Rights as required.

    For example, the API user may have read-only permissions to their Personal and Contract tabs. This allows the API to perform GETs on the data in those two screens, but no POST, PUT, DELETE, etc.

    The Personal and Contract checkboxes in Advanced Set Rights.

  4. Select Save.

Change an API User's status

  1. Find the API user you want to deactivate and select the dropdown arrow.

  2. Select Change Status.

    The Change Status option.

  3. Select Deactivate on the pop-up displayed.

  4. The Status of the API user changes from Active to Inactive.

    Delete an API User

  5. Find the API User you want to delete and select the dropdown arrow.

  6. Select Delete.

    The Delete option.

  7. The user's details are removed from the API Users list.

    Reset an API User's password

  8. Find the API User whose password you want to update and select the dropdown arrow.

  9. Select Reset Password.

    The Reset Password option.

  10. A pop-up displays showing the new Password. Select Copy Password and make a note of it for future reference.

  11. Select Close on the pop-up.