Guide Index
Guides HomeMangoApps WebsiteCommunity & SupportBlog & Resources
MangoApps Administrators Guide
MangoApps Administrators Guide
  • 🥭MangoApps Admin Guides
  • 🆕Admin Portal Navigation Bar
    • Recommendations
      • Increase Findability
  • Home
    • Dashboard
    • Pending Invites
    • Pending Approvals
    • Logs
      • Audit Log
      • User Access Log
      • Assistants Log
      • Security Log
      • Connector Log
      • Imports Log
      • Learn Automations Log
      • xAPI Activity Log
      • Webhook Log
      • Debug Log
      • Schedule Sync Log
    • Trash Can
      • Trash Can Tools
      • Trash Can Widget
    • Data Exports
  • 🆕Domain Setup
    • General Settings
    • Getting Started
      • Introduction Video
      • Terms of Service/ Privacy Policy
      • Change Password
      • Profile Items
      • Locale
      • Team Recommendations
      • Notifications
      • Invite
    • AI Settings
    • Page Templates
      • Design a Page Template
    • Locale
    • Digital Signage
    • Translate
      • Translate Modules
      • Glossary
      • Translate Settings
    • Startup Dialog
    • 🆕Reactions
    • Compose
    • 🆕Locations
      • 🆕General Settings
      • Locations
        • Adding an Office Location
      • Location Fields
      • Location Summary
      • Webhooks
    • 🆕Field Structures
      • Field Member Automation
      • 🆕Field Hierarchy Sync
    • Holidays
    • Companies
    • Resources
    • Service Usage
    • 🆕My Priority Items
  • 🆕User Management
    • Manage Users
    • Add Users
      • Invite Users
      • Import Users
        • Synchronize Users From ADP
      • Synchronize Users From AD/LDAP
      • Fetch From URL
      • Share Sign Up Link
      • Import Via API
    • Organizations
    • Admin Roles
      • Admin Role Permissions
    • User Segments
    • Team Segments
    • Assistants
    • 🆕Alias
    • 🆕User Status
    • Guest Users
      • Create a Guest User
    • Restricted Users
  • 🆕Modules
    • Ballots
    • Calendar
      • Calendar Event Types
      • Calendar Settings
      • Calendar Integrations
    • Campaigns
      • Settings
      • Templates
      • Categories
    • Chats
    • Company
    • CRM
      • Setup
      • Stages
      • Types
      • Lead Sources
      • Opportunities Access
      • All Opportunities
      • More Options
    • Departments
    • 🆕Files
      • 🆕Settings
      • File Storage
      • External Repositories
      • Cloud Folders
      • 🆕Manage
      • Configure Custom Fields
      • 🆕Show/Hide File Fields
    • Greetings
      • Manage Greetings
      • Manage Categories
      • Settings
    • 🆕Groups
      • 🆕Automatic Membership Management
    • Hashtags
      • Manage Hashtags
      • Categories
      • Settings
    • 🆕Home
      • 🆕Dashboard Selection
        • 🆕Web
        • Mobile
      • Settings
    • Ideas
      • Manage Ideas
      • Idea Categories
      • Idea Settings
    • Libraries
    • Media Center
      • Settings
      • Categories
      • Media Card
      • Custom Fields
    • Messages
    • My Recordings
    • 🆕News Feed
      • General Settings
      • 🆕Left Panel Widgets
      • 🆕Right Panel Widgets
    • Notes
      • Settings
      • Templates
    • 🆕People
      • 🆕Settings
      • 🆕Full Profile
        • Managing Profile Fields
      • Profile Preview
      • People Directory
      • Org Chart
      • Skills
      • Webhooks
    • 🆕Posts
      • Settings
      • Content Template
      • Alert Template
      • Categories
      • 🆕AI Actions & Workers
    • Projects
      • Project Templates
    • Quizzes
    • Recognition
      • Settings
      • Data Sources
        • Add Data Source
          • Create Custom Items Tracker
          • Order History Tracker
      • Reward Catalog
      • Award Categories
      • Awards
      • Core Values
      • Reward Points Allocation
      • Order & User History
      • Recognition Insights
    • 🆕Schedules
      • Shift Data Source
        • Integration with Kronos
      • Tab Settings
        • Attendance Reports
      • 🆕Schedule Settings
      • Attendance Settings
      • Availability
    • Setup
    • 🆕Surveys
    • 🆕Tasks
      • 🆕Task Settings
      • Task Types
      • Task Priorities
      • Task Templates
      • Task Automations
      • Task Tabs
    • To Do
      • Settings
      • Sections
    • Trackers & Forms
      • Create a Tracker Template
      • Configure Tracker Settings
    • Vault
      • Employee Vaults
      • Integration
      • Audit
      • Folders
      • Settings
      • Vault Permissions
    • Wikis
  • 🆕Navigation
    • 🆕Add New Navigation
    • Navigation Styles
    • Add Custom Links
    • FAQ
  • 🆕Email
    • Configuration
    • Content
    • 🆕Digest
    • Accepted List
    • Rejected List
    • Unsubscribed Users
  • Notifications
    • Settings
    • Security Notification
    • External Apps
  • SSO
    • Connections
    • Applications
  • Search
    • Insights
    • Data Sources
    • Saved Searches
    • Relevance Tuning
    • Look Ahead Sections
    • Search Settings
  • Automation
  • 🆕Security
    • Browser Access
    • 🆕Desktop & Mobile Access
    • User Devices
    • Synced Computers
    • Password Settings
    • Session Settings
    • Virus Scan
  • Compliance
    • Accessibility
    • Delete Settings
    • Self Destruct
    • Data Retention
    • eDiscovery
      • Create a Hold
    • DLP Policies
      • Policy Rules
      • Matches Log
      • Create a DLP Policy
    • Terms of Service
    • Usage Policy
    • Email Compliance
    • Export Data
  • Moderation
    • Queue
    • Insights
    • Settings
  • 🆕Governance
    • Overview
    • Items
    • 🆕Automation
    • Archived
    • Settings
  • Social Advocacy
    • Social Advocacy Tools
    • Settings
    • Social Posts
    • Insights
    • Social Posts Sharing
  • Integrations
    • MangoApps Open APIs
    • Webhooks
  • Branding
    • Branding Toolbars
    • Portal
      • Custom Branding Colors
      • Home Page: Modern vs. Classic View
      • Text Styles
    • Content
    • Widgets
    • Profile
    • Footer
    • Email
    • Custom
      • Add a Custom Header
    • Image Recommendations
    • ⭐Branding Implementation Checklist
  • 🆕Reports
    • Reports Tools
    • Generate a Report
    • FTP Export
    • 🆕Report Settings
  • Analytics
    • Adoption Dashboard
    • ROI Dashboard
    • Engagement Dashboard
    • Content Dashboard
  • Billing & Invoices
    • Plan
    • Invoice
    • Settings
  • Help Center Setup
    • Settings
    • Admin Training Videos
    • User Training Videos
    • Webinars & Videos
    • Help Center
  • Sitemap
  • 🚫Deprecated Features By Release
    • 🚫Activities (Deprecated)
    • 🚫Landing Page (Removed)
    • 🚫MangoApps File Sync Guide (Deprecated)
      • 🚫File Sync (Deprecated)
        • 🚫File Sync Tools (Deprecated)
      • 🚫Installation & Upgrade (Deprecated)
      • 🚫My Drive Sync
      • 🚫Synced Files
      • 🚫Synced Preferences
      • 🚫Notifications
      • 🚫Team Sync
    • 🚫Screen Share (Deprecated)
      • 🚫Screen Share Tools
      • 🚫Screen Share (Messenger)
    • 🚫Screen Share/Video Call Log
    • 🚫Type-2 Organizations (Deprecated)
    • 🚫Voice (Moved)
  • ADDITIONAL RESOURCES
    • Submit a Support Ticket
    • Release Notes
Powered by GitBook
On this page
  • Overview
  • Configure Synchronization Settings
  • Configure Advanced Sync Settings
  • Configure API Endpoint and Parameters
  • Configure Authentication Options
  • Preview & Synchronize
  1. User Management
  2. Add Users

Import Via API

Importing and adding MangoApps users from an API

PreviousShare Sign Up LinkNextOrganizations

Last updated 3 months ago

Overview

MangoApps allows administrators to bulk import users via API by configuring the endpoint and mapping API fields to user fields in MangoApps. Follow the steps below to successfully import users.


Configure Synchronization Settings

Navigate to Synchronize Settings and select when to synchronize users from the API.

Choose one of the following options:

  • One Time Import (All Users): Imports and syncs users only once.

  • On User Login:

    • On First Login: Syncs users when they log in for the first time.

    • On Every Login: Syncs users every time they log in.

Users imported via Admin Portal > Users > Add Users > Import via API are automatically assigned the "Network User" role, regardless of their email domain.


Configure Advanced Sync Settings

This section will only appear if One Time Import (All users) is selected in the above Synchronization Settings.

In When Fetched Users Already Exist in MangoApps, choose an option:

  • Skip Existing Users: Avoids overwriting existing user data.

  • Update Existing Users: Overwrites existing user data.

In Email Invites for Newly Added Users, check the box to send login credentials via email to new users.


Configure API Endpoint and Parameters

A request will be sent to the listed URL to sync all users.

In Import API URL, select the preferred method from the dropdown menu (e.g., "GET") and enter the API URL.

Request Parameters - On User Login Synchronize Option Only

  • Enter the API field name in API Field.

  • Enter the corresponding MangoApps field name in MangoApps Field.

  • Click + Add to add more parameters or Remove to delete parameters.

Response Parameters - Required for Either Synchronize Option

  • Enter the API field name in API Field.

  • Enter the corresponding MangoApps field name in MangoApps Field.

  • Check User Identifier for the field that uniquely identifies users. Only one field can be marked as the user identifier.

  • Click + Add to add more parameters or Remove to delete parameters.

The API field names in request and response parameters must match the third-party API field names.


Configure Authentication Options

When connecting to the HCM/HRIS system to retrieve user profile data, select the method that best suits your system's security and integration requirements.

Enter the necessary authentication details:

  • OAuth Token URL

  • Authorization URL

  • Username

  • Password

Click Save Settings & Test Connection to verify the configuration.


Preview & Synchronize

Click Preview & Synchronize to review the user data before importing. If everything is correct, click Synchronize to complete the process. Once the import is successful, a confirmation message appears, and the system sends an email notification to the network admin.

🆕