User Management

This page shows you how to interact with your projects users using our API

Quick Tips

Usernames cannot exceed a length of 20 and they must have a minimum length of 3, they also cannot contain any special characters

User notes cannot exceed a length of 20 and they must have a minimum length of 3

Get Users

GET https://api.luashield.com/projects/:project_id/users

Get all users for your project

Path Parameters

Name	Type	Description
project_id*	String	ID of your project

Headers

Name	Type	Description
LuaShield-API-Key*	String	API Key

200: OK Users

[
	{
		"id": "cf62582a-932d-48e2-9d09-5b436ba33337",
		"Key": "9c50a05d869a459dcf271b76757b8d47ab7a4c1fb89373fb3cbca7c44d751d70e3d0530a97e580b9ccf8b02aa6cdaf68d38aa6133c5451bde091395ec640b5e6",
		"Username": "balls",
		"HWID": null,
		"ProjectID": "3851df88-139e-4e1d-8229-02ed58595e9b",
		"Executions": 0,
		"CrackAttempts": 0,
		"Exploit": null,
		"Whitelisted": true,
		"CreatedAt": "2023-04-10T04:28:57.674Z",
		"ExpireAt": null,
		"MaxExecutions": 0,
		"Note": "dsf",
		"DiscordID": "787086729470541844"
	},
	{
		"id": "16b6eb05-c472-4dcd-8945-1081880d8ec7",
		"Key": "0ba6138c137b18db762cc5f2d1690723a0084d24f6a6ecb0c821a40ff9cc1776be758755e18a40bc4092ce6eece56bcc17dca0ea3a7435e655a9122a54a1f2dc",
		"Username": "dsflikesmen",
		"HWID": null,
		"ProjectID": "3851df88-139e-4e1d-8229-02ed58595e9b",
		"Executions": 0,
		"CrackAttempts": 0,
		"Exploit": null,
		"Whitelisted": true,
		"CreatedAt": "2023-04-10T04:29:05.241Z",
		"ExpireAt": null,
		"MaxExecutions": 0,
		"Note": "dsf",
		"DiscordID": "787086729470541844"
	}
]

402: Payment Required Subscription Expired

{
    "error": "Your subscription has expired"
}

401: Unauthorized Invalid API Key

{
    "error": "Invalid API Key"
}

403: Forbidden You don't own this project

{
    "error": "You don't own this project"
}

404: Not Found This project doesn't exist

Create User

This will return the users license key unhashed

POST https://api.luashield.com/projects/:project_id/users

Create a user

Path Parameters

Name	Type	Description
project_id*	String	ID of your project

Headers

Name	Type	Description
LuaShield-API-Key*	String	API Key

Request Body

Name	Type	Description
username*	String	Username to give the user
whitelisted*	Boolean	User is whitelisted?
discord_id	String	Users Discord ID
max_executions	Int	Limit users executions
expire	Int	Unix Epoch timestamp of when user should expire
note	String	Note to give to the user

200: OK User

{
	"id": "8f4cdc8c-b6ad-445a-9701-d27696ea1f72",
	"Key": "91990b05-0030-4626-a38a-d597422aa957",
	"Username": "dsflikesmen2",
	"HWID": null,
	"ProjectID": "3851df88-139e-4e1d-8229-02ed58595e9b",
	"Executions": 0,
	"CrackAttempts": 0,
	"Exploit": null,
	"Whitelisted": true,
	"CreatedAt": "2023-04-10T15:10:52.924Z",
	"ExpireAt": null,
	"MaxExecutions": 0,
	"Note": "dsf",
	"DiscordID": "787086729470541844"
}

403: Forbidden You don't own this project

{
    "error": "You don't own this project"
}

402: Payment Required Subscription Expired

{
    "error": "Your subscription has expired"
}

401: Unauthorized Invalid API Key

{
    "error": "Invalid API Key"
}

Update User

PATCH https://api.luashield.com/projects/:project_id/users

Update a user

Path Parameters

Name	Type	Description
project_id	String	Project ID

Headers

Name	Type	Description
LuaShield-API-Key*	String	API Key

Request Body

Name	Type	Description
username*	String	Username of the user
whitelisted*	Boolean	User is whitelisted?
expire	Int	Unix Epoch timestamp of when user should expire
max_executions	Int	Limit users executions
discord_id	String	Users Discord ID
note	String	User note

200: OK Update user

{
	"id": "8f4cdc8c-b6ad-445a-9701-d27696ea1f72",
	"Key": "7be331a58cc2b530e747d896b5557f7e7e884e50fab23f7aca4e1256ccc03fcfa8956fd8a121423990fb67340a1ebc7f9026377fb9099abb23fbc2677185bd5a",
	"Username": "dsflikesmen2",
	"HWID": null,
	"ProjectID": "3851df88-139e-4e1d-8229-02ed58595e9b",
	"Executions": 0,
	"CrackAttempts": 0,
	"Exploit": null,
	"Whitelisted": true,
	"CreatedAt": "2023-04-10T15:10:52.924Z",
	"ExpireAt": 1681222821000,
	"MaxExecutions": 0,
	"Note": "omg updated",
	"DiscordID": "78708672947054184"
}

403: Forbidden You don't own this project

{
    "error": "You don't own this project"
}

404: Not Found This user doesn't exist

{
    "error": "This user doesn't exist"
}

401: Unauthorized Invalid API Key

{
    "error": "Invalid API Key"
}

402: Payment Required Subscription Expired

{
    "error": "Your subscription has expired"
}

Delete User

DELETE https://api.luashield.com/projects/:project_id/users

Delete User

Path Parameters

Name	Type	Description
project_id*	String	Project ID

Headers

Name	Type	Description
LuaShield-API-Key*	String	API Key

Request Body

Name	Type	Description
username*	String	Username of the user to delete

200: OK Deleted user

{
    "success": true
}

403: Forbidden You don't own this project

{
    "error": "You don't own this project"
}

404: Not Found User doesn't exist

{
    "error": "This user doesn't exist"
}

401: Unauthorized Invalid API key

{
    "error": "Invalid API Key"
}

402: Payment Required Subscription Expired

{
    "error": "Your subscription has expired"
}

Reset Key

POST https://api.luashield.com/projects/:project_id/users/reset_key

Reset Key

Path Parameters

Name	Type	Description
project_id*	String	Project ID

Headers

Name	Type	Description
LuaShield-API-Key*	String	API Key

Request Body

Name	Type	Description
username*	String	Username of the user

200: OK Successfully reset users key

{
	"Key": "738a2553-83c7-4b72-a5b3-1b2f2b52faa4"
}

403: Forbidden You don't own this project

{
    "error": "You don't own this project"
}

404: Not Found This user doesn't exist

{
    "error": "This user doesn't exist"
}

401: Unauthorized Invalid API Key

{
    "error": "Invalid API Key"
}

402: Payment Required Subscription Expired

{
    "error": "Your subscription has expired"
}

Reset HWID

POST https://api.luashield.com/projects/:project_id/users/reset_hwid

Reset users HWID

Path Parameters

Name	Type	Description
project_id*	String	Project ID

Headers

Name	Type	Description
LuaShield-API-Key*	String	API Key

Request Body

Name	Type	Description
username*	String	Username of the user

200: OK Successfully reset HWID

{
    "success": true
}

401: Unauthorized Invalid API Key