III.2.d. Users

Contents

• Get specific user ban information
• Get all users ban information
• Get specific registered user information
• Get all registered users information
• Get user IP address

Requests

Get specific user ban information

/api/bannedUser.json?ip=<ip>

Returns information about a banned user. IP address may be specified in IPv4 or IPv6 format.

Note: Your access level must be MODER or higher.

Example:

/api/bannedUser.json?ip=5.254.**.***

{
    "ip": "::***:****",
    "bans": {
        "a": {
            "boardName": "a",
            "expiresAt": null,
            "level": "READ_ONLY",
            "reason": "",
            "postNumber": null,
            "createdAt": "2016-02-23T18:12:38.217Z"
        },
        "b": {
            "boardName": "b",
            "expiresAt": null,
            "level": "READ_ONLY",
            "reason": "",
            "postNumber": null,
            "createdAt": "2016-02-23T18:12:38.217Z"
        },
        ...
    },
    "ipv4": "5.254.**.***"
}

If the user is not banned, the bans property will be an empty object.

On any error, an error object is returned.

Example:

/api/bannedUser.json?ip=5.254.**.abc

{
    "title": "Error",
    "errorMessage": "Error",
    "errorDescription": "Invalid IP address"
}

Get all users ban information

/api/bannedUsers.json

Returns information about all banned users.

Note: Your access level must be MODER or higher.

Example:

/api/bannedUsers.json

[
    {
        "ip": "::***:****",
        "bans": {
            "a": {
                "boardName": "a",
                "expiresAt": null,
                "level": "READ_ONLY",
                "reason": "",
                "postNumber": null,
                "createdAt": "2016-02-23T18:12:38.217Z"
            },
            "b": {
                "boardName": "b",
                "expiresAt": null,
                "level": "READ_ONLY",
                "reason": "",
                "postNumber": null,
                "createdAt": "2016-02-23T18:12:38.217Z"
            },
            ...
        },
        "ipv4": "5.254.**.***"
    },
    ...
]

On any error, an error object is returned.

Example:

/api/bannedUsers.json

{
    "title": "Error",
    "errorMessage": "Error",
    "errorDescription": "Not enough rights"
}

Get specific registered user information

/api/registeredUser.json?hashpass=<hashpass>

Returns information about a registered user.

Note: Your access level must be SUPERUSER.

Example:

/api/registeredUser.json?hashpass=****************************************

{
    "hashpass": "****************************************",
    "levels": {
        "3dpd": "MODER",
        "a": "MODER",
        "b": "MODER",
        "cg": "MODER",
        "d": "MODER",
        "echo": "MODER",
        "h": "MODER",
        "int": "MODER",
        "mlp": "MODER",
        "po": "MODER",
        "pr": "MODER",
        "rf": "MODER",
        "rpg": "MODER",
        "soc": "MODER",
        "vg": "MODER"
    },
    "ips": []
}

On any error, an error object is returned.

Example:

/api/registeredUser.json?hashpass=not_a_hashpass

{
    "title": "Error",
    "errorMessage": "Error",
    "errorDescription": "Invalid hashpass"
}

Get all registered users information

/api/registeredUsers.json

Returns information about all registered users.

Note: Your access level must be SUPERUSER.

Example:

/api/registeredUsers.json

[
    {
        "hashpass": "****************************************",
        "levels": {
            "3dpd": "MODER",
            "a": "MODER",
            "b": "MODER",
            "cg": "MODER",
            "d": "MODER",
            "echo": "MODER",
            "h": "MODER",
            "int": "MODER",
            "mlp": "MODER",
            "po": "MODER",
            "pr": "MODER",
            "rf": "MODER",
            "rpg": "MODER",
            "soc": "MODER",
            "vg": "MODER"
        },
        "ips": []
    }
]

On any error, an error object is returned.

Get user IP address

/api/userIp.json?boardName=<boardName>&postNumber=<postNumber>

Returns an object containing the user's IP address in IPv6 form and possibly the user's IP address in IPv4 form (if convertable).

Note: Your access level must be ADMIN or higher, if not set to other value using the configuration file.

Example:

/api/userIp.json?boardName=b&postNumber=29552

{
    "ip": "::****:****",
    "ipv4": "207.244.**.***"
}

On any error, an error object is returned.

Example:

/api/userIp.json?boardName=b&postNumber=100500

{
    "title": "Error",
    "errorMessage": "Error",
    "errorDescription": "No such post"
}