User Management Documentation

Overview

This set of endpoints provides user management functionality including session management, user creation, updating, deletion, and retrieval. All endpoints require a Blaze Team Advanced or White Labeling subscription.

Base URL

https://api.blazesql.com

Authentication

• All endpoints require a valid API key
• Must have an active Blaze Team Advanced or White Labeling subscription
• API keys should be kept secure and never exposed in client-side code

Request Formats

All endpoints accept either GET or POST requests. Parameters can be passed as URL parameters for both methods, or as a JSON body for POST requests.

Get User Session Link

Generate a login session link for a specified user.

Endpoint Path

/user_authentication_api

Parameters

Example Requests

Using URL Parameters:

GET https://api.blazesql.com/user_authentication_api?user_email=user@example.com&api_key=your_api_key_here&hide_sidebar=true

Using JSON Body:

POST https://api.blazesql.com/user_authentication_api
Content-Type: application/json

{
    "api_key": "your_api_key_here",
    "user_email": "user@example.com",
    "hide_sidebar": true
}

Create New User

Creates a new user in your team with specified database access.

Endpoint Path

/user_creation_api

Parameters

Example Requests

Using URL Parameters:

GET https://api.blazesql.com/user_creation_api?api_key=your_api_key_here&email=newuser@example.com&database_id=db123&role=Developer&simplified_mode=false&technical=true

Using JSON Body:

POST https://api.blazesql.com/user_creation_api
Content-Type: application/json

{
    "api_key": "your_api_key_here",
    "email": "newuser@example.com",
    "database_id": "db123",
    "role": "Developer",
    "simplified_mode": false,
    "technical": true
}

Update User

Updates an existing user's information and database access permissions.

Endpoint Path

/user_update_api

Parameters

Database Access Object Format

{
    "database_id_1": "view",
    "database_id_2": "edit",
    "database_id_3": null  // Removes access
}

Valid permission levels:

• "view": Read-only access
• "edit": Read and write access
• null: Remove access

Example Requests

Using URL Parameters:

GET https://api.blazesql.com/user_update_api?api_key=your_api_key_here&email=user@example.com&role=Senior+Developer&database_access={"db123":"view","db456":"edit","db789":null}

Using JSON Body:

POST https://api.blazesql.com/user_update_api
Content-Type: application/json

{
    "api_key": "your_api_key_here",
    "email": "user@example.com",
    "role": "Senior Developer",
    "database_access": {
        "db123": "view",
        "db456": "edit",
        "db789": null
    }
}

Delete User

Removes a user from your team and queues them for deletion.

Endpoint Path

/user_deletion_api

Parameters

Example Requests

Using URL Parameters:

GET https://api.blazesql.com/user_deletion_api?api_key=your_api_key_here&email=user@example.com

Using JSON Body:

POST https://api.blazesql.com/user_deletion_api
Content-Type: application/json

{
    "api_key": "your_api_key_here",
    "email": "user@example.com"
}

List All Users

Retrieves a list of all users in your team with their roles and settings.

Endpoint Path

/user_retrieval_api

Parameters

Example Requests

Using URL Parameters:

GET https://api.blazesql.com/user_retrieval_api?api_key=your_api_key_here

Using JSON Body:

POST https://api.blazesql.com/user_retrieval_api
Content-Type: application/json

{
    "api_key": "your_api_key_here"
}

Response Format

{
    "users": [
        {
            "email": "user@example.com",
            "role": "Developer",
            "technical": true,
            "simplified_mode": false,
            "database_access": {
                "db123": "view",
                "db456": "edit"
            }
        }
    ]
}

Common Response Codes

Security Best Practices

1. Always use HTTPS for requests
2. Keep API keys secure and never expose them in client-side code
3. Use a separate API key for each application or service
4. Regularly rotate API keys
5. Monitor API usage for unusual patterns
6. Review database access permissions regularly

Rate Limits and Quotas

Please contact support for information about rate limits and usage quotas for your subscription level.

Updated on: 28/05/2025