Automated User Provisioning

This documentation explains how to use our automated user provisioning system via SFTP, CSV uploads, and API. Our system allows you to efficiently create and manage user accounts by automating the import process.

Overview

Our platform supports three methods for automated user provisioning:

• SFTP Uploads: Securely transfer CSV files via SFTP.
• CSV Uploads: Directly upload CSV files through our web interface.
• API Uploads: Provision users programmatically using our API endpoint (configured specifically for your account).

Prerequisites

Before you begin, ensure you have the following:

• Access Credentials: Email us at YOUR-Account-Manager@auxoai.com to receive your credentials and endpoint configuration details. These will be provisioned specifically for your account. Two-factor authentication is required for web interface and API access. SFTP access is secured through SSH keys and IP whitelisting.
• A CSV file formatted as per our CSV Format Specification (for SFTP and CSV uploads).
• An active user provisioning account.

SFTP Uploads

To provision users via SFTP, follow these steps:

1. Connect to the SFTP Server
   Use your preferred SFTP client to connect to the server using the credentials provided to you after emailing YOUR-Account-Manager@auxoai.com. Your account will be provisioned with a unique SFTP endpoint:

   • Hostname: sftp_youraccount.auxoai.com
   • Port: 22
   • Username: Your assigned username
   • Password: Your assigned password

2. Upload Your CSV File
   Place your CSV file in the designated directory (e.g., /upload).

3. Automatic Processing
   Our system automatically detects the CSV file and processes it to provision the user accounts as specified.

4. Confirmation
   You will receive a confirmation email once the CSV file has been successfully processed.

CSV Uploads via Web Interface

Alternatively, you can upload your CSV file directly through our web interface:

1. Log In
   Access your account at https://youraccount.auxoai.com.

2. Navigate to User Provisioning
   Click on the "User Provisioning" section in your dashboard.

3. Upload CSV
   Use the "Upload CSV" button to select and upload your CSV file.

4. Processing and Notification
   The system processes the file and notifies you of the provisioning results.

API Uploads

For a more integrated solution, you can provision users programmatically via our API:

1. API Endpoint Configuration
   Your account will be configured with a unique API endpoint for user provisioning. Contact us at YOUR-Account-Manager@auxoai.com to obtain your API credentials and endpoint details.

2. Submit User Data
   Send a POST request to your API endpoint with user data formatted in JSON. Refer to our API documentation for details on request structure and required fields.

3. Processing and Response
   Our system processes the request and returns a response indicating the status of the provisioning. Successful submissions will automatically create the user accounts as specified.

CSV Format Specification

Ensure that your CSV file is formatted correctly. The required columns are:

Column Name	Description	Example
username	Unique identifier for the user	jdoe
email	User's email address	jdoe@auxoai.com
first_name	User's first name	John
last_name	User's last name	Doe
role	Role assigned to the user (optional)	admin or user

Note: If instructed, do not include header rows in your CSV file.

User Authentication

Security Measures

• Web Interface & API: Two-factor authentication is required for enhanced security.
• SFTP Access: Secured through SSH key authentication and IP whitelisting. Contact your account manager to configure these security measures.

Single Sign-On (SSO)

Once users are provisioned, they can access the platform using Single Sign-On (SSO). SSO can be configured for your organization, allowing users to authenticate using your existing identity provider. Contact your account manager to set up and configure SSO for your organization.

For More Information

If you have any questions or need assistance obtaining credentials, please email us at YOUR-Account-Manager@auxoai.com.

---

By following these instructions, you can ensure a smooth and secure automated user provisioning process using SFTP, CSV uploads, or API integration.