User endpoints

info

these are endpoints relating to users

Getting user info

GET /users/:user_key

Parameters

Name	Type	Description
user_key	String	The users key

Response

Success

{
    "success": true,
    "user": {
        "key": "USER_KEY",
        "project_id": "PROJECT_ID",
        "discord_id": "DISCORD_ID",
        "fingerprint_assigned": true,
        "executor": "EXECUTOR",
        "executions": 0,
        "key_expires": 1770624500000,
        "last_reset": 1770538100000,
        "total_fingerprint_resets": 0,
        "note": "NOTE",
        "blacklisted": false,
        "blacklist_reason": null,
        "blacklist_expires": null,
        "total_sessions": 0,
        "total_instances": 0,
        "luaauth_fingerprint": "⬛⬛⬛⬛⬛⬛ -> ip\n⬛⬛⬛⬛⬛⬛ -> fingerprint\n⬛⬛⬛⬛⬛⬛ -> executor"
    }
}

Editing a user

POST /users/:user_key/edit

Parameters

Name	Type	Description
user_key	String	The users key

Body

Name	Type	Nullable	Description
discord_id	String	✅	users discord id
key_expires	Number	✅	Unix ms timestamp for users key to expire, -1 for infinite
note	String	✅	Note for user
max_instances	Number	✅	Advanced key control field, max instances a user can have at once, 0 for infinite
max_executions	Number	✅	Advanced key control field, max executions for a user
use_fingerprint	Boolean	✅	Advanced key control field, disabling this will prevent the key from being fingerprint locked
blacklist_expires	Number	✅	Must be null if user isnt blacklisted, the duration of the users blacklist
blacklist_reason	Number	✅	Must be null if user isnt blacklisted, the reason for user blacklist

Response

Success

{ "success": true }

Error

Code	Message
0	account expired
1	key already exists with this discord
2	cannot edit nothing
3	tier missing advanced key control feature
4	cannot edit blacklist data when user isnt blacklisted

Blacklisting a user

POST /users/:user_key/blacklist

Parameters

Name	Type	Description
user_key	String	The users key

Body

Name	Type	Nullable	Default	Description
expires	String	❌		Unix ms timestamp for when blacklist expires, -1 for infinite
reason	Number	✅	Null	Reason for blacklisting user

Response

Success

{ "success": true }

Error

Code	Message
0	user already blacklisted
1	account expired

Unblacklisting a user

POST /users/:user_key/unblacklist

Parameters

Name	Type	Description
user_key	String	The users key

Response

Success

{ "success": true }

Error

Code	Message
0	user not blacklisted
1	account expired

Resetting a users fingerprint

POST /users/:user_key/reset

Parameters

Name	Type	Description
user_key	String	The users key

Body

Name	Type	Nullable	Description
force	Boolean	❌	Bypass user cooldown

Response

Success

{ "success": true }

Error

Code	Message	Extra
0	account expired
1	user doesnt have an assigned fingerprint
2	project has resetting fingerprints disabled
3	must wait before resetting fingerprint	cooldown_remaining: COOLDOWN_MS_LEFT

Linking a user to a discord

POST /users/:user_key/link

Parameters

Name	Type	Description
user_key	String	The users key

Body

Name	Type	Nullable	Description
discord_id	String	❌	Discord id to link to
force	Boolean	❌	Ignore if key is already linked to a discord

Response

Success

{ "success": true }

Error

Code	Message
0	account expired
1	key already has a discord assigned to it
2	a key already exists with this discord

Deleting a user

POST /users/:user_key/remove

Parameters

Name	Type	Description
user_key	String	The users key

Response

Success

{ "success": true }

Getting sessions

POST /users/:user_key/sessions

Parameters

Name	Type	Description
user_key	String	The users key

Body

Name	Type	Nullable	Description
from	Number	✅	Start index for list
limit	Number	✅	Amount of sessions to return

Response

Success

{
    "success": true,
    "sessions": [{
        "id": "SESSION_ID",
        "user_key": "USER_KEY",
        "script_id": "SCRIPT_ID",
        "roblox_id": 10234711811,
        "place_id": 606849621,
        "job_id": "JOB_ID",
        "created_at": 1770624500000
    }]
}

Filtering sessions

GET /users/:user_key/sessions/filter

Parameters

Name	Type	Description
user_key	String	The users key

Queries

Name	Type	Nullable	Description
from	Number	✅	Start index for list
limit	Number	✅	Amount of sessions to return
script_id	String	✅	Script id session must have
roblox_id	String	✅	Roblox id of the session
place_id	String	✅	Place id session must be in
job_id	String	✅	Job id session must be in

Response

Success

{
    "success": true,
    "sessions": [{
        "id": "SESSION_ID",
        "user_key": "USER_KEY",
        "script_id": "SCRIPT_ID",
        "roblox_id": 10234711811,
        "place_id": 606849621,
        "job_id": "JOB_ID",
        "created_at": 1770624500000
    }]
}

Error

Code	Message
0	must filter something