Skip to main content
Connector guides

Connect AvePoint

AvePoint is a Microsoft 365 data protection and governance vendor. A partner manages its customers in AvePoint Elements for Partners. Backups of Microsoft 365 run in Cloud Backup for Microsoft 365,…

Written By Christopher Scaminaci

Last updated 13 days ago

AvePoint is a Microsoft 365 data protection and governance vendor. A partner manages its customers in AvePoint Elements for Partners. Backups of Microsoft 365 run in Cloud Backup for Microsoft 365, which belongs to AvePoint Online Services. StackJack connects an AI assistant to both products through AvePoint's published APIs.

Connecting AvePoint to StackJack gives your AI assistant a family of avepoint_ MCP tools. MCP (Model Context Protocol) tools are the standardized commands an AI assistant can call through StackJack. With them, your AI can:

  • See your customers - the customers under your partner, their Microsoft 365 tenants, their services and licenses, and the protected objects and users in each tenant
  • Follow the work - jobs, job reports, scan profiles and their change history, audit logs, and the Cloud Backup jobs, unusual activities, backup frequency and retention policy
  • Review posture - baselines and their deviation reports, risk management findings, Azure cost and security issues, and user and workspace management data
  • Run a large account reseller practice - resellers, their pooled subscriptions, allocation usage history and the reseller audit trail
  • Change things (on Pro plans) - onboard a customer, add a service, add tenants to modules, generate a consent link, change baselines and user attributes, accept or reject pooled subscriptions, and start a restore

How StackJack authenticates to AvePoint

AvePoint does not use a user name and password for its API. You create an app registration in each product, and StackJack signs in with it. StackJack asks AvePoint for a one-hour access token on its own, for exactly the permission the tool needs, keeps the token and renews it as long as it is in use. You never copy a token, and the AI never sees one.

The two products use two separate app registrations:

  • Elements for Partners - required. It gives the customer, service, job, baseline, risk, user management, workspace management and pooled subscription tools. It uses one fixed address, so you do not enter one.
  • Cloud Backup for Microsoft 365 - optional. It gives the Cloud Backup tools and two AvePoint Online Services tools. You choose the data center your tenant is in, and that choice decides the address StackJack calls.

If you do not add the Cloud Backup registration, only the Cloud Backup tools stop working. The Elements tools run as before.

Creating the Elements app registration

  1. Sign in to AvePoint Elements and open Settings, then API app registration. Register a new app.
  2. Choose the permissions you want the AI to have. Each tool needs exactly one permission, for example elements.customers.read.all for the customer list. A tool whose permission you did not grant fails with a message that names the permission, and no other tool is affected.
  3. Create a client secret (it can last 1, 2 or 3 years), or upload a certificate.
  4. Copy the application (client) ID and, for a secret, the secret value. AvePoint shows the secret only once.
  5. Note the environment you signed in to: Commercial, U.S. Government, AOS2 or FedRAMP (Project Hosts).

Creating the Cloud Backup app registration (optional)

  1. Sign in to AvePoint Online Services and open the app registration for the modern API.
  2. Grant the microsoft365backup permissions you want, for example microsoft365backup.jobInfo.read.all to read jobs and microsoft365backup.restore.readwrite.all to start a restore. The two AvePoint Online Services tools need their own permissions: audit.read.all for the audit records and autodiscovery.readwrite.all for the scan jobs.
  3. Create a client secret or upload a certificate, and copy the application (client) ID and the secret.
  4. Note the data center your tenant is in and the environment.

Using a certificate instead of a secret

A certificate registration signs in without a secret. StackJack signs a short-lived proof of identity with the certificate's private key, and the private key is stored encrypted in Azure Key Vault.

StackJack takes the certificate and the private key as PEM text, with the key unencrypted. If you have a .pfx file, convert it with OpenSSL:

openssl pkcs12 -in certificate.pfx -clcerts -nokeys -out certificate.pem
openssl pkcs12 -in certificate.pfx -nocerts -nodes -out private-key.pem

Paste the contents of certificate.pem into Certificate (PEM) and the contents of private-key.pem into Private key (PEM). Use an RSA key. Keep the files private and delete them when you are done.

Connect it in StackJack

  1. Open Connectors, then AvePoint.
  2. In the Elements for Partners section, choose the Environment, enter the Application (client) ID, choose Client secret or Certificate, and enter the secret, or the certificate and the private key.
  3. To add Cloud Backup, fill in every field of that section: Data center, Environment, Application (client) ID and the secret or the certificate. Leave the section empty to skip it. A section that is only half filled is refused.
  4. Click Test connection. StackJack signs in with each registration you entered and reads one page of a list. Both steps change nothing.

Enter all the values again whenever you save the connection, including when you only rename it.

What is worth knowing before you start

The registration's permissions decide what AvePoint allows

Every call acts as the app registration, so the AI sees and changes only what the permissions you granted allow. There is no per-person attribution: every call is made as the app. When a registration lacks the permission a tool needs, the tool says which permission is missing, and the refusal does not count against the connection. Grant the permissions the AI needs and no more.

Some tools accept either of two permissions

For a few baseline tools the vendor allows either a read permission or a read-write permission. StackJack asks for the first, and if AvePoint reports that the registration lacks it, StackJack tries the other.

Paging

Elements lists page with pageIndex, which starts at 1, and pageSize, which is at most 100. Some lists use an opaque skipToken that you pass back unchanged. The Cloud Backup lists page with pageIndex, which starts at 0. StackJack never follows a link from an answer on its own.

About thirty Elements read tools use a POST request with a JSON filter, because that is how AvePoint offers them. They are still reads.

Changing things

The tools that onboard customers, add services, add tenants to modules, generate authorization links, add, accept or reject pooled subscriptions, change a user's account or password setting, apply baselines to a tenant, or start a restore are on the Pro tier, are marked destructive and ask for approval before they run. Other changes, such as creating a baseline and user attributes, are Pro and ask for approval too. A service or a pooled subscription can cost money, and a restore overwrites or adds data, so check what a call will do before you approve it.

The storage profile list can answer storage passwords and keys. The two authorization-link tools answer with a consent URL. Whoever opens that URL can grant AvePoint access to a customer's Microsoft 365 tenant. StackJack never records those answers and never turns them into download links. Onboarding a customer sends a password, and StackJack never records that call's arguments.

What is not offered

StackJack offers the Elements for Partners v3 API, the Cloud Backup for Microsoft 365 API and two AvePoint Online Services calls (audit records and scan jobs). The older Elements address family that AvePoint has replaced is not offered, and neither are AvePoint's other products, such as EnPower, Insights, Opus or Confide.

When AvePoint refuses a call

  • The app registration is refused: the application ID or the secret is wrong, the secret has expired, or the certificate does not match the registration. Create a new secret or check the certificate, then paste the values again.
  • A permission is missing: the answer names it. Add it to the app registration in AvePoint and try again.
  • The environment does not match: a registration made in one environment cannot sign in at another. Choose the environment where you created it.
  • Not found: check the ids with avepoint_elements_list_customers, avepoint_elements_get_m365_tenant_info, avepoint_elements_list_users, avepoint_elements_list_jobs and avepoint_m365_list_jobs.
  • Rate limited: AvePoint does not publish a limit. StackJack paces its calls and backs off when AvePoint asks it to slow down.

Client secrets expire. Replace the secret in StackJack before its date.

Plans and limits

Reads are available on the Free tier. The tools that change things are Pro. Business reaches the same tools as Pro and differs by monthly call quota.

See the generated AvePoint tool reference for the current inventory, plan assignment, input schemas and destructive-action labels.

AvePoint tools

avepoint_ · 78 tools · Free 49 · Pro 29

Customers

ToolWhat it does
avepoint_elements_list_customers
Free · Read-only
Use this API to retrieve the information of all customers managed by the current partner.
avepoint_elements_list_protected_objects
Free · Read-only
Use this API to retrieve customer's protected objects of Cloud Backup for Microsoft 365. Needs the elements.cbprotected.read.all permission on the app registration.
avepoint_elements_onboard_customer
Pro · Destructive
DESTRUCTIVE.

Customer tenants and apps

ToolWhat it does
avepoint_elements_add_customer_tenants_to_modules
Pro · Destructive
DESTRUCTIVE.
avepoint_elements_create_app_consent_link
Pro · Destructive
DESTRUCTIVE.
avepoint_elements_create_tenant_auth_link
Pro · Destructive
DESTRUCTIVE.
avepoint_elements_get_m365_tenant_info
Free · Read-only
Use this API to retrieve information of a Microsoft 365 tenant.
avepoint_elements_get_service_app_status
Free · Read-only
Use this API to retrieve the status of a service app for a Microsoft 365 tenant.

Services and licensing

ToolWhat it does
avepoint_elements_add_service
Pro · Destructive
DESTRUCTIVE.
avepoint_elements_list_services
Free · Read-only
Use this API to retrieve the services of customers managed by the current partner.
avepoint_elements_list_storage_profiles
Free · Read-only
Use this API to retrieve storage profiles.

Tenant seats and products

ToolWhat it does
avepoint_elements_get_product_overview
Free · Read-only
Use this API to retrieve the number of purchased user seats for AvePoint products of the customer.
avepoint_elements_list_tenant_user_seats
Free · Read-only
Use this API to retrieve the numbers of assigned and available user seats of the customer's tenant.
avepoint_elements_list_user_protected_status
Free · Read-only
Use this API to retrieve the protected status of users in the customer's tenant by Cloud Backup for Microsoft 365. Needs the elements.cbprotected.read.all permission on the app registration.

Jobs and scan profiles

ToolWhat it does
avepoint_elements_get_cloud_backup_overview
Free · Read-only
Use this API to retrieve the customer's protected data information of Cloud Backup for Microsoft 365. Needs the elements.cbprotected.read.all permission on the app registration.
avepoint_elements_get_job_report
Free · Read-only
Use this API to retrieve the backup job report details of the Cloud Backup for Microsoft 365 service of a specific customer.
avepoint_elements_get_scan_profile
Free · Read-only
Use this API to retrieve the details of a specific scan profile configured in AvePoint Online Services for a customer.
avepoint_elements_list_jobs
Free · Read-only
Use this API to retrieve the job details for a specific job type and module of backup services, including Cloud Backup for Microsoft 365, Cloud Backup for Google Workspace, Cloud Backup for IaaS + PaaS, Cloud Backup for Dynamics 365, and Cloud Backup for Salesforce.
avepoint_elements_list_scan_profile_changes
Free · Read-only
Use this API to retrieve the daily scan profile changes in AvePoint Online Services for a customer.
avepoint_elements_list_scan_profiles
Free · Read-only
Use this API to retrieve all scan profiles configured for a specific customer in AvePoint Online Services.

Audit

ToolWhat it does
avepoint_elements_get_audit_log
Free · Read-only
Use this API to retrieve common audit log records.

Large account reseller

ToolWhat it does
avepoint_elements_accept_pooled_subscriptions
Pro · Destructive
DESTRUCTIVE.
avepoint_elements_get_lar_audit_log
Free · Read-only
Use this API to retrieve audit log records under the current LAR.
avepoint_elements_get_pooled_subscription_usage
Free · Read-only
Use this API to retrieve allocation usage history of a pooled subscription.
avepoint_elements_list_pooled_subscriptions
Free · Read-only
Use this API to retrieve all pooled subscriptions under the current LAR.
avepoint_elements_list_reseller_pooled_subscriptions
Free · Read-only
Use this API to retrieve all pooled subscriptions of a reseller under the current LAR.
avepoint_elements_list_resellers
Free · Read-only
Use this API to retrieve all resellers under the current LAR.
avepoint_elements_reject_pooled_subscriptions
Pro · Destructive
DESTRUCTIVE.
avepoint_elements_set_pooled_subscription
Pro · Destructive
DESTRUCTIVE.

Azure cost and security

ToolWhat it does
avepoint_elements_list_azure_cost_issues
Free · Read-only
Use this API to retrieve Azure cost issues in a customer's tenant.
avepoint_elements_list_azure_risk_issues
Free · Read-only
Use this API to retrieve Azure risk issues in a customer's tenant.

Baseline management

ToolWhat it does
avepoint_elements_create_baseline
Pro · Write
Use this API to create a baseline from a tenant to establish benchmarks for tenant configurations.
avepoint_elements_get_baseline_creation_report
Free · Read-only
Use this API to retrieve the report details of a baseline creation job.
avepoint_elements_list_baseline_tenants
Free · Read-only
Use this API to retireve the general information of tenants added to the Baseline Management module.
avepoint_elements_list_baselines
Free · Read-only
Use this API to retrieve the general information of baselines.
avepoint_elements_list_process_center_jobs
Free · Read-only
Use this API to retrieve job information from the Process center page.
avepoint_elements_monitor_tenant
Pro · Destructive
DESTRUCTIVE.

Risk management

ToolWhat it does
avepoint_elements_list_matched_risk_rules
Free · Read-only
Use this API to retrieve all matched risk rules for a specific tenant in Elements.
avepoint_elements_list_risk_rule_hit_items
Free · Read-only
Use this API to retrieve the objects that violate a specific risk rule within a specific tenant in Elements.

User management

ToolWhat it does
avepoint_elements_get_compliance_category
Free · Read-only
Use this API to retrieve compliance information of a specific workflow in a customer's tenant.
avepoint_elements_get_hybrid_agents
Free · Read-only
Use this API to retrieve information of hybrid agents for a customer's tenant.
avepoint_elements_get_risky_action_count
Free · Read-only
Use this API to retrieve the risky action count in a customer's tenant.
avepoint_elements_get_security_users
Free · Read-only
Use this API to retrieve information of security users in a customer's tenant.
avepoint_elements_get_sign_in_information
Free · Read-only
Use this API to retrieve users' sign-in information in a customer's tenant.
avepoint_elements_get_user
Free · Read-only
Use this API to retrieve information of a user in a customer's tenant.
avepoint_elements_get_workflow_information
Free · Read-only
Use this API to retrieve information of workflows in a customer's tenant.
avepoint_elements_list_users
Free · Read-only
Use this API to retrieve information of multiple users in a customer's tenant.
avepoint_elements_update_cloud_user_contact
Pro · Write
Use this API to update the contact information of a cloud user in a customer's tenant.
avepoint_elements_update_cloud_user_general
Pro · Write
Use this API to update the general information of a cloud user in a customer's tenant.
avepoint_elements_update_cloud_user_office
Pro · Write
Use this API to update the office information of a cloud user in a customer's tenant.
avepoint_elements_update_cloud_user_office_location
Pro · Write
Use this API to update the office location information of a cloud user in a customer's tenant.
avepoint_elements_update_local_user_contact
Pro · Write
Use this API to update the contact information of a hybrid/local user in a customer's tenant.
avepoint_elements_update_local_user_general
Pro · Write
Use this API to update the general information of a hybrid/local user in a customer's tenant.
avepoint_elements_update_local_user_notes
Pro · Write
Use this API to update the notes of a hybrid/local user in a customer's tenant.
avepoint_elements_update_local_user_office
Pro · Write
Use this API to update the office information of a hybrid/local user in a customer's tenant.
avepoint_elements_update_local_user_office_location
Pro · Write
Use this API to update the office location information of a hybrid/local user in a customer's tenant.
avepoint_elements_update_local_user_profile
Pro · Write
Use this API to update the profile of a hybrid/local user in a customer's tenant.
avepoint_elements_update_user_account_information
Pro · Destructive
DESTRUCTIVE.
avepoint_elements_update_user_alternate_email
Pro · Write
Use this API to update the alternate email address of a user in a customer's tenant.
avepoint_elements_update_user_birthday
Pro · Write
Use this API to update the birthday of a user in a customer's tenant.
avepoint_elements_update_user_external_flag
Pro · Write
Use this API to update the external user property of a user in a customer's tenant to indicate whether the user is an external user.
avepoint_elements_update_user_manager
Pro · Write
Use this API to update the manager of a user in a customer's tenant.
avepoint_elements_update_user_password_setting
Pro · Destructive
DESTRUCTIVE.
avepoint_elements_update_user_sponsor
Pro · Write
Use this API to update the sponsor of a user in a customer's tenant.
avepoint_elements_update_user_test_flag
Pro · Write
Use this API to update the test user property of a user in a customer's tenant to indicate whether the user account is a test user for development purposes.

Workspace management

ToolWhat it does
avepoint_elements_get_workspace_compliance
Free · Read-only
Use this API to retrieve the compliance statistics of workspaces for a specific tenant in Elements.
avepoint_elements_get_workspace_data_protection
Free · Read-only
Use this API to retrieve the data protection statistics of a specific tenant in Elements.
avepoint_elements_get_workspace_data_security_posture
Free · Read-only
Use this API to retrieve the data security posture statistics of a specific tenant in Elements.
avepoint_elements_get_workspace_overview
Free · Read-only
Use this API to retrieve the workspace overview statistics of a specific tenant in Elements.

Cloud Backup for Microsoft 365

ToolWhat it does
avepoint_m365_get_backup_frequency
Free · Read-only
Get the backup frequency of all active services (/backup/m365/settings/backup/frequency navigation property) from Cloud Backup for Microsoft 365. By invoking the /backup/m365/settings/backup/frequency endpoint, users can get how often each service is backed up and when backup jobs are scheduled to run, helping you verify that your data protection policies are correctly applied.
avepoint_m365_get_job
Free · Read-only
Get detailed information for a specific job (/backup/m365/cloudbackupjobs/{jobId} navigation property) from Cloud Backup for Microsoft 365. By invoking the /backup/m365/cloudbackupjobs/{jobId} endpoint, users can retrieve detailed job data, including status, execution timing, summary counts, and top errors, providing clear visibility into the performance and results of an individual job.
avepoint_m365_get_retention_policy
Free · Read-only
Get the retention policy (/backup/m365/settings/retention-policy navigation property) configured in Cloud Backup for Microsoft 365. By invoking the /backup/m365/settings/retention-policy endpoint, users can retrieve the current data retention configuration to know how long backup data is retained.
avepoint_m365_get_subscription_consumption
Free · Read-only
Get the subscription consumption information (/backup/m365/cloudbackuplicenseconsumption navigation property) of Cloud Backup for Microsoft 365. By invoking the /backup/m365/cloudbackuplicenseconsumption endpoint, users can gain comprehensive insights into subscription usage, facilitating efficient resource management and ensuring service compliance.
avepoint_m365_list_jobs
Free · Read-only
List jobs and get job-related information (/backup/m365/cloudbackupjobs navigation property) from Cloud Backup for Microsoft 365. By invoking the /backup/m365/cloudbackupjobs endpoint, users can gain comprehensive insights and granular access to job reports, enhancing the ability to manage, analyze, and optimize backup operations with precision and efficiency.
avepoint_m365_list_unusual_activities
Free · Read-only
Get the basic information of unusual activities (/backup/m365/cloudbackupunusualactivitydata navigation property) detected by Cloud Backup for Microsoft 365. By invoking the /backup/m365/cloudbackupunusualactivitydata endpoint, users can gain the number of sites with unusual activities and that are under potential ransomware attacks in your tenant.
avepoint_m365_start_restore_job
Pro · Destructive
DESTRUCTIVE.

AvePoint Online Services

ToolWhat it does
avepoint_aos_list_audit_records
Free · Read-only
Use this API to retrieve audit records (/aos/audit navigation property) for activities within your AOS tenant.
avepoint_aos_list_scan_jobs
Free · Read-only
Get the scan job information (/aos/jobs navigation property) from AvePoint Online Services.