Versions Compared

Old Version 47

changes.mady.by.user Lasse Langhorn

Saved on

compared with

New Version Current

changes.mady.by.user Lasse Langhorn

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Code Block
languagejson
{
  "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.

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

<CONFLUENCE_BASE_URL>/rest/confluenceuserexport/1.0/file/json

Converting Confluence users as JSON to a JSON file.

POST

Content-type: application/json

Accept: application/json

Authorization: Basic (<username:password>base64)

REQUEST:

The payload below is a list of user objects that needs to be converted.

Code Block
languagejson
[
  {
    "username": "tester",
    "active": true,
    "fullName": "tester",
    "email": "tester@mail.com",
    "directoryName": "Confluence Internal Directory",
    "createdDate": "2019-09-03 22:50",
    "updatedDate": "2019-09-19 09:20",
    "lastLogin": "2019-09-19 09:28",
    "groups": [
      "testing-space5",
      "confluence-users",
      "testing-space"
    ],
    "preferredLanguage": "Default",
    "canUse": true
  }
]
RESPONSE:

The response from server with the name of the file created and the path to the file on Confluence server.

Code Block
languagejson
{
  "fileName": "confluenceuserexport111f5467-e0de-457e-b7a2-366fdcde1b94.json",
  "filePath": "/path/to/confluence/temp/confluenceuserexport111f5467-e0de-457e-b7a2-366fdcde1b94.json"
}

<CONFLUENCE_BASE_URL>/rest/confluenceuserexport/1.0/file/xml

Converting Confluence users as JSON to a XML file.

POST

Content-type: application/json

Accept: application/json

Authorization: Basic (<username:password>base64)

REQUEST:

The payload below is a list of user objects that needs to be converted.

Code Block
languagejson
[
  {
    "username": "tester",
    "active": true,
    "fullName": "tester",
    "email": "tester@mail.com",
    "directoryName": "Confluence Internal Directory",
    "createdDate": "2019-09-03 22:50",
    "updatedDate": "2019-09-19 09:20",
    "lastLogin": "2019-09-19 09:28",
    "groups": [
      "testing-space5",
      "confluence-users",
      "testing-space"
    ],
    "preferredLanguage": "Default",
    "canUse": true
  }
]
RESPONSE:

The response from server with the name of the file created and the path to the file on Confluence server.

Code Block
languagejson
{
  "fileName": "confluenceuserexport111f5467-e0de-457e-b7a2-366fdcde1b94.json",
  "filePath": "/path/to/confluence/temp/confluenceuserexport111f5467-e0de-457e-b7a2-366fdcde1b94.json"
}

<CONFLUENCE_BASE_URL>/rest/confluenceuserexport/1.0/file/csv

Converting Confluence users as JSON to a CSV file.

POST

Content-type: application/json

Accept: application/json

Authorization: Basic (<username:password>base64)

REQUEST:

The payload below is a list of user objects that needs to be converted.

Code Block
languagejson
[
  {
    "username": "tester",
    "active": true,
    "fullName": "tester",
    "email": "tester@mail.com",
    "directoryName": "Confluence Internal Directory",
    "createdDate": "2019-09-03 22:50",
    "updatedDate": "2019-09-19 09:20",
    "lastLogin": "2019-09-19 09:28",
    "groups": [
      "testing-space5",
      "confluence-users",
      "testing-space"
    ],
    "preferredLanguage": "Default",
    "canUse": true
  }
]
RESPONSE:

The response from server with the name of the file created and the path to the file on Confluence server.

Code Block
languagejson
{
  "fileName": "confluenceuserexport111f5467-e0de-457e-b7a2-366fdcde1b94.json",
  "filePath": "/path/to/confluence/temp/confluenceuserexport111f5467-e0de-457e-b7a2-366fdcde1b94.json"
}

<CONFLUENCE_BASE_URL>/rest/confluenceuserexport/1.0/file/xlsx

Converting Confluence users as JSON to a XLSX file.

POST

Content-type: application/json

Accept: application/json

Authorization: Basic (<username:password>base64)

REQUEST:

The payload below is a list of user objects that needs to be converted.

Code Block
languagejson
[
  {
    "username": "tester",
    "active": true,
    "fullName": "tester",
    "email": "tester@mail.com",
    "directoryName": "Confluence Internal Directory",
    "createdDate": "2019-09-03 22:50",
    "updatedDate": "2019-09-19 09:20",
    "lastLogin": "2019-09-19 09:28",
    "groups": [
      "testing-space5",
      "confluence-users",
      "testing-space"
    ],
    "preferredLanguage": "Default",
    "canUse": true
  }
]
RESPONSE:

The response from server with the name of the file created and the path to the file on Confluence server.

Code Block
languagejson
{
  "fileName": "confluenceuserexport111f5467-e0de-457e-b7a2-366fdcde1b94.json",
  "filePath": "/path/to/confluence/temp/confluenceuserexport111f5467-e0de-457e-b7a2-366fdcde1b94.json"
}

...