Import Via API

Importing and adding MangoApps users from an API

Bulk Importing Users Via API

You can bulk import users from an API by configuring the endpoint and mapping the fields in the API to the user fields in MangoApps. To import users:

In the Synchronize settings, select when to synchronize the users from the API.
1. Select One Time Import (All users) to import users and sync users only once. OR
2. Select On User Login to sync users when a user logs in for the first time (On First Login) or sync users every time they log in (On Every Login) to your domain.
Configure the Advanced Sync Settings.
1. In the When Fetched Users Already Exist in MangoApps option, select the Skip existing users option to NOT overwrite the data of existing users. OR
  Select the Update existing users option to overwrite the data of existing users.
2. In the Email Invites For Newly Added Users option, mark the checkbox to send an email to all the new users with their login credentials.
Configure the endpoint and parameters for the API.
1. In the Import API URL option, select the preferred method. For example, select the "Get" method from the drop-down list and enter the API URL in the text box.
2. In the Request Parameters option, enter the API field name in API Field text box and enter the MangoApps field name in the MangoApps Field text box. For example, enter email in the API Field text box and select the Email ID field from the drop-down. Click the + Add button to add more request parameters and click the Remove button to remove a request parameter.
  These request parameters are sent for the request to the API, the fields are matched, and the values are fetched back to MangoApps in the response.
3. In the Response Parameters option, enter the API field name in API Field text box and enter the MangoApps field name in the MangoApps Field text box. For example, enter email in the API Field text box and select the Email ID field from the drop-down. Mark the User Identifier checkbox to use the field as the unique identifier for each user. You can mark only one field as the user identifier. Click the + Add button to add more response parameters and click the Remove button to remove a response parameter.
  These response parameters are fetched in the response from the API, mapped and then saved to the specified MangoApps fields.
Configure the Authentication options.
1. In the OAuth Token URL text box, enter the unique URL for the authentication token when MangoApps tries to connect to the API for the data.
2. In the Authorization URL, enter the unique URL for the authorization when MangoApps tries to connect to the API for the data.
3. In the Username text box, enter the username for the authentication when MangoApps tries to connect to the API for the data.
4. In the Password text box, enter the password for the authentication when MangoApps tries to connect to the API for the data.
Click the Save Settings & Test Connections button to save the configurations and test the API connection. The system displays a success message on verifying all the configurations and successfully connecting to the API.
Click the Preview & Synchronize button to import users via API as configured. The system displays a pop-up with the user data for synchronization, click the Synchronize button. The system displays a success message on importing the users successfully via the API.

The API field name in the API field text box for the request and response parameters MUST match your third-party API fields for successful data exchanges. Refer to your third-party API specifications for the API field names used for user data.

After a successful import, the system sends an email to the network admin who is importing the users.

Users imported and invited via Admin Portal > Users > Add Users > Import via API are automatically assigned the "Network User" role irrespective of their email address. For example, if the network (of help-docs.com) invites a user with the email address brendon@example.com or fraser@yahoo.com, then these users are added as network users even if their email address does not match the company domain (for example user@help-docs.com).

PreviousShare Sign Up Link NextSynchronize Users From ADP

Last updated 5 years ago

Bulk Importing Users Via API

You can bulk import users from an API by configuring the endpoint and mapping the fields in the API to the user fields in MangoApps. To import users:

In the Synchronize settings, select when to synchronize the users from the API.

Select One Time Import (All users) to import users and sync users only once. OR
Select On User Login to sync users when a user logs in for the first time (On First Login) or sync users every time they log in (On Every Login) to your domain.

Configure the Advanced Sync Settings.

In the When Fetched Users Already Exist in MangoApps option, select the Skip existing users option to NOT overwrite the data of existing users. OR
Select the Update existing users option to overwrite the data of existing users.
In the Email Invites For Newly Added Users option, mark the checkbox to send an email to all the new users with their login credentials.

Configure the endpoint and parameters for the API.

In the Import API URL option, select the preferred method. For example, select the "Get" method from the drop-down list and enter the API URL in the text box.
In the Request Parameters option, enter the API field name in API Field text box and enter the MangoApps field name in the MangoApps Field text box. For example, enter email in the API Field text box and select the Email ID field from the drop-down. Click the + Add button to add more request parameters and click the Remove button to remove a request parameter.
These request parameters are sent for the request to the API, the fields are matched, and the values are fetched back to MangoApps in the response.
In the Response Parameters option, enter the API field name in API Field text box and enter the MangoApps field name in the MangoApps Field text box. For example, enter email in the API Field text box and select the Email ID field from the drop-down. Mark the User Identifier checkbox to use the field as the unique identifier for each user. You can mark only one field as the user identifier. Click the + Add button to add more response parameters and click the Remove button to remove a response parameter.
These response parameters are fetched in the response from the API, mapped and then saved to the specified MangoApps fields.

Configure the Authentication options.

In the OAuth Token URL text box, enter the unique URL for the authentication token when MangoApps tries to connect to the API for the data.
In the Authorization URL, enter the unique URL for the authorization when MangoApps tries to connect to the API for the data.
In the Username text box, enter the username for the authentication when MangoApps tries to connect to the API for the data.
In the Password text box, enter the password for the authentication when MangoApps tries to connect to the API for the data.

Click the Save Settings & Test Connections button to save the configurations and test the API connection. The system displays a success message on verifying all the configurations and successfully connecting to the API.

Click the Preview & Synchronize button to import users via API as configured. The system displays a pop-up with the user data for synchronization, click the Synchronize button. The system displays a success message on importing the users successfully via the API.

After a successful import, the system sends an email to the network admin who is importing the users.

Did this article help? Your feedback adds value when we shape up the help articles. Hit the smileybelow to let us know!