Loading ...

REST API: Administration | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Administration
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 30

REST API: Administration

0 
 /5
0 (0votes)
Open API Guide

Automate system property updates, manage global look-and-feel variables, and programmatically adjust feature visibility. This API ensures consistent configuration across large-scale Axero deployments.

Available Endpoints

Method Endpoint Description
PUT Activate User /api/users/activate Activate a pending user by user ID or username
POST Add URL Mapping /api/urlmapper Provides programmatic access for the creation and processing of add url mapper resources.
PUT Ban User /api/users/banstatus Ban or unban a user from the intranet
GET Check If Two Factor Authentication Is Enabled /api/users/{UserID}/2fa/enabled Check if two-factor authentication is enabled for a particular user
GET Check Username Availability /api/user/availability Check if a username is available for use or not
DELETE Delete URL Mapping /api/urlmapper/multiple Provides an automated mechanism for removing delete urlmappings data from the system.. Warning: If 'fromURL' is provided, the API will delete all mappings pointing from that URL.
DELETE Disable Two Factor Authentication /api/users/{UserID}/2fa Disable Two-Factor Authentication for a particular user. Only a site administrator can disable 2FA for other users.
GET Get Abuse Report /api/content/abuses Allows an administrator to get details of abused content.
GET Get Abuse Report Types /api/content/abuseTypes Allows a member to get all the types of abuse reports present in the application.
GET Get Administrators /api/users/administrators Enables administrators and developers to programmatically retrieve a list of all users with the top level Site Administrator role or space Administrator role.
GET Get Administrators and Moderators /api/users/adminmoderators Enables administrators and developers to programmatically retrieve a list of all users with the top level Site Administrator and Moderator roles or space Administrator and Moderator roles.
GET Get Countries /api/countries Enables administrators and developers to programmatically retrieve a list of countries and their IDs.
GET Get Link Metadata /api/link/metadata Returns the detailed view of the Link URL that needs to be shared.
GET Get States /api/states Enables administrators and developers to programmatically retrieve a list of states and their IDs.
GET Get Two Factor Authentication Qr Code /api/users/passcode/qrcode Enables administrators and developers to programmatically retrieve the Two-Factor Authentication QR code for a particular user.
GET Get URL Mapping /api/urlmapper Enables administrators and developers to programmatically retrieve URL mapping details.
POST Rebuild Index /api/admin/buildindex Technical reference for the Rebuild Index By Content Type ID endpoint, providing programmatic access to rebuild index by content type id functionality.
POST Report Abusive Content /api/content/abuses Allows a member to report abusive content.
GET Search /api/search Searches across your intranet for content matching specified criteria. Supports Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Albums, Forums, Forum Groups, Forum Topics, and Foru...
PUT Validate User /api/users/validate Verify if a user's credentials are correct. This acts as a security check for custom login systems. Only administrators can run this request, making it perfect for secure back-end integrations that...

Wiki Index

Pages