Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Call Instructions:

  1. This interface can query all confluence users, and supports fuzzy query based on user name

  2. This interface can only be called by system administrators


Interface Information

Name

GetUserList

Address

/rest/tools/1.0/api/user/getUserList

Method

GET

Return Type

Json

Authentication

Basic,token

Parameters

Parameter name

Required

Parameter type

Description

userName

N

String

Username, support fuzzy query, case-insensitive

page

N

int

Paging parameter, offset, defaults to 0

pageSize

N

int

Page parameter, number of lines, maximum limit 100, default 10

return value format

Field

Type

Description

code

int

Appendix - Code

msg

String

total

int

Total data

isMore

bool

true or false

data

String

[{

    "name":"user name",

    "key":"user key",

    "fullName":"full name",

    "email":"email",

     “groups”:[“confluence-user”]

}]


Example Postman call


Example return value

{
    "code": 0,
    "msg": "Success",
    "total": 1,
    "isMore": false,
    "data": [
        {
            "name": "admin",
            "key": "2c9d829d6e61f011016e61f143ff0000",
            "fullName": "admin",
            "email": "admin@example.com",
            "groups": [
                "confluence-administrators",
                "confluence-users"
            ]
        }
    ]
}

  • No labels