Creating a services user (exclusive to API)

<< Click to Display Table of Contents >>

Creating a services user (exclusive to API)

This procedure is intented solely for companies assigned to an external application that connects to our API or that uses our new API. This user type cannot be used for authentication in the payroll application and the mobile application.  

✓Only an application manager can create a Service User.  

Access: User management > Add a user

1Under Identification, select the Type of use “Services user”.

2Enter the desired User code.

▪The user code must contain between 6 and 10 alphanumeric characters.

3Select the Application associated to the user. If your company has the new API configuration, the New API option will appear in the dropdown menu. Select it and proceed to the next step.    

4For Status, select “Active”.

5Under the Communication settings, select the communication language.

6Click on Next.

7Select the companies and structures to which you wish to grant access by checking the corresponding boxes.  

Tips and tricks

To grant access to all companies or the entire structure, check the Access to all companies box and/or the Access to the entire structure box.

8Click on Next.

 

NET red-pointer

If you selected the New API option, hmtoggle_plus1click here to follow the next steps; otherwise, proceed to the next step.

a.Click Integrate. This allows you to create an application in Gravitee, subscribe to the APIs from the service user’s developer portal, or regenerate their access credentials.  

b.A Service user integration via API window will display the Client ID and Client secret. Make sure to carefully note this information and provide it to the developer responsible for the API calls.

Once creation is complete, a Remove button allows you to delete the application created in Gravitee, as well as revoke access to the developer portal APIs.

Things to remember

The application is automatically removed in the following cases:

▪The user is deactivated or terminated.

▪The user becomes inactive due to no login activity in our application for 45 days.

▪Another application is associated with the user.

9Carefully read the information on the screen, then click on Print letter to produce a letter containing the password and the user code that you will provide to the new user.

▪Please submit the enterprise code, the service user code and the password to your provider so that this information will be integrated into the service application.

▪Once the password is reinitialized, it becomes permanent (no update is required afterward).

10Click on Finish to complete the creation.  

 

For more information

Users Management - Additional information