API Calls for Managing Users (Invite/Delete)

Trouble Viewing Images? Right-click on any image and select "Open in new tab" to view a larger version. You can also zoom in using Ctrl + Mouse Wheel for easier readability.

Article Goal

Learn how to use the InviteUsers and DeleteUsers WebReports API endpoints to manage users via API calls.

Why Use the Users API?

The Users API allows administrators or developers with API access to manage WebReports users programmatically. This includes the ability to invite new users and delete existing ones, making user management more flexible and scriptable.

✅ Tip
API-based user management is ideal for environments where onboarding and offboarding need to be automated or integrated with external systems.

API Prerequisites

Before using the API, ensure the following:

• ✅ Your account has the API role in WebReports.

• ✅ A secure connection (via valid API key or session cookie) is established.

• ✅ The APISettings: AllowAPIKeysForVDM is enabled in your appsettings.json file.

✅ Tip
If your appsettings.json does not already include this section, be sure not to add a trailing comma if it’s at the end of the file.

Video Tutorial

Not yet available.

Available User Management Endpoints

These endpoints are part of the WebReports external API for user management:

InviteUsers Endpoint

Endpoint

/extapi/APIWebReport/InviteUsers

This endpoint accepts a list of InviteUsers objects, which includes user email, roles, and connection assignments.

JSON Payload Structure

public class InviteUsers {
    public string Email { get; set; }
    public List<string> Roles { get; set; }
    public List<string> Connections { get; set; }
}

Example: VB.NET Implementation

' Create the user list
Dim Users As New List(Of InviteUsers)

' Create a user
Dim User As New InviteUsers
User.Email = "user@example.com"

' Assign roles
Dim UserRoles As New List(Of String)
UserRoles.Add("Role1")
UserRoles.Add("Role2")
User.Roles = UserRoles

' Assign connections
Dim UserConnections As New List(Of String)
UserConnections.Add("Connection1")
User.Connections = UserConnections

' Add to the list
Users.Add(User)

' Send to API
Dim Params As StringContent = New StringContent(JsonConvert.SerializeObject(Users, Formatting.Indented), Encoding.UTF8, "application/json")
Dim openResponse = client.PostAsync("server/extapi/APIWebReport/InviteUsers", Params).GetAwaiter().GetResult()

DeleteUsers Endpoint

Endpoint

/extapi/APIWebReport/DeleteUsers

This endpoint accepts a list of strings representing usernames (login names) to be deleted.

Example: VB.NET Implementation

' Create the list of usernames to delete
Dim Users As New List(Of String)
Users.Add("User1")
Users.Add("User2")

' Send to API
Dim Params As StringContent = New StringContent(JsonConvert.SerializeObject(Users, Formatting.Indented), Encoding.UTF8, "application/json")
Dim openResponse = client.PostAsync("server/extapi/APIWebReport/DeleteUsers", Params).GetAwaiter().GetResult()

Article Summary

The WebReports API provides two core endpoints—InviteUsers and DeleteUsers—to manage user access via automation or external applications. These endpoints support scalable management by allowing batch processing of user invitations and deletions. To use them, ensure proper configuration of your appsettings.json file, including enabling API key support. Developers can programmatically create or remove users by submitting JSON-formatted payloads through secure HTTP POST requests, significantly streamlining administrative workflows.