Using REST API

When Confluence User Export is installed it is possible to use the REST API and servlets for creating files with user information. With the REST API and servlets you do not have to use the Confluence user interface for exporting each time. You can automate the user export if needed. Use the Python scripts here for this automation.

REST endpoints

URL

Description

HTTP Method

HTTP headers

HTTP Request payload

<CONFLUENCE_BASE_URL>/rest/confluenceuserexport/1.0/search

This is the endpoint that can be used for searching Confluence users.

POST

Content-type: application/json

Accept: application/json

Authorization: Basic (<username:password>base64)

EXAMPLE 1

The payload below get the 20 first users that are active or inactive starting from 0.

{
  "searchString": "",
  "activeUsers": true,
  "inActiveUsers": true,
  "offset": 0,
  "pageSize": 20
}

EXAMPLE 2

The payload below get the 50 first users that are active or inactive starting from 0 where the user email contains @mail.com.

{
  "searchString": "@mail.com",
  "activeUsers": true,
  "inActiveUsers": true,
  "offset": 0,
  "pageSize": 50
}

Servlets

URL	Description	HTTP Method	HTTP headers	HTTP Request payload