Groups

Create a new group

POST /permissions/new/group

This will create a new permission group.

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Body

Name

Type

Description

roleId

UUIDv4

This is the permission group database id

roleName

string

This is the group name

rolePriority

number

This is the priority of the group

roleColor

string

This is the groups color

rolePrefix

string

This is the prefix of the group in-game

roleSuffix

string

This is the suffix of the group in-game

Response

{
    "created": boolean
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

Delete a group

DELETE /permissions/delete/group/[ Group Id ]

This will delete a permission group from an id.

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Request

Name

Type

Description

Group Id

UUIDv4

This is the database group id

Response

{
    "deleted": boolean
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

Add a user to a group

POST /permissions/new/group/user/[ Group Id ]/[ User Id ]

This will add a user to a group.

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Request

Name

Type

Description

Group Id

UUIDv4

This is the database group id

User Id

UUIDv4

This is the database user id

Response

{
    "created": boolean
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

Remove a user from a group

DELETE /permissions/delete/group/user/[ Group Id ]/[ User Id ]

This will remove a user from a group.

Headers

Name

Value

Content-Type

application/json

Authorization

<key>

Request

Name

Type

Description

Group Id

UUIDv4

This is the database group id

User Id

UUIDv4

This is the database user id

Response

{
    "deleted": boolean
}

If authorization header not provided:

{
    "error": {
        "code": 403
        "message": "Please specify an authorization key!"
    }
}

If invalid authorization key:

{
    "error": {
        "code": 403,
        "message": "Invalid authorization Key!"
    }
}

Get a group from a group name

POST /permissions/get/group/name/[ Group Name ]

This will return a group from a group name

Headers

Name

Value

Content-Type

application/json

Body

Name

Type

Description

Group Name

string

Name of the group

Response

If can find a group from a name:

{
    "users": [
        "string"
    ],
    "group": {
        "roleId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO",
        "roleName": "string",
        "rolePriority": number,
        "roleColor": "string", 
        "rolePrefix": "string",
        "roleSuffix": "string"
    },
    "permissions": [
        {
            "permissionId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO",
            "permission": "string",
            "cooldown": number
        }
    ]
}

If cannot find a group from a name:

null

Get a group from a group id

POST /permissions/get/group/name/[ Group Id ]

This will return a group from a group name

Headers

Name

Value

Content-Type

application/json

Body

Name

Type

Description

Group Id

UUIDv4

This is the database user id

Response

If can find a group from an id:

{
    "users": [
        "string"
    ],
    "group": {
        "roleId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO",
        "roleName": "string",
        "rolePriority": number,
        "roleColor": "string", 
        "rolePrefix": "string",
        "roleSuffix": "string"
    },
    "permissions": [
        {
            "permissionId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO",
            "permission": "string",
            "cooldown": number
        }
    ]
}

If cannot find a group from an id:

null

Get all groups for user

POST /permissions/get/groups/user/[ User Id ]

This will return a list of all the groups the user is a part of.

Headers

Name

Value

Content-Type

application/json

Request

Name

Type

Description

User Id

UUIDv4

This is the database user id

Response

[
    {
        "users": [
            "string"
        ],
        "group": {
            "roleId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO",
            "roleName": "string",
            "rolePriority": number,
            "roleColor": "string", 
            "rolePrefix": "string",
            "roleSuffix": "string"
        },
        "permissions": [
            {
                "permissionId": "OOOOOOO-OOOO-OOOO-OOOO-OOOOOOOOOOOO",
                "permission": "string",
                "cooldown": number
            }
        ]
    }
]

Does group contain user

GET /permissions/get/group/contains/[ Group Id ]/[ User Id ]

This will return a boolean if a group contains a specific user.

Headers

Name

Value

Content-Type

application/json

Request

Name

Type

Description

Group Id

UUIDv4

This is the database group id

User Id

UUIDv4

This is the database user id

Response

{
    "contains": boolean
}

Does group exist with a specific name

GET /permissions/get/groups/exists/[ Group Name ]

This will return a boolean if a group contains a specific user.

Headers

Name

Value

Content-Type

application/json

Request

Name

Type

Description

Group Name

string

This is the group name

Response

{
    "exists": boolean
}

PreviousPermissions NextDefault Value Routes

Last updated 1 year ago