Users

Gets a list of users

Retrieves a list of users

URL : /api/users

Method : GET

Auth required : YES

Limit: None

Success Response

Code : 200 OK

Content examples

Example response:

[
    {
        id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
        email: "[email protected]",
        name: "Jim Smith",
        enabled: true,
        admin: true,
        owner: true,
        createdAt: 2022-06-12T06:50:00.021Z,
        updatedAt: 2022-06-12T06:50:00.021Z
    }
]

Gets a single user

Search an article using a keyword

URL : /api/user/:id

Method : GET

Auth required : YES

Limit: Single user

Success Response

Code : 200 OK

Content examples

Example response:

{
    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
    email: "[email protected]",
    name: "Jim Smith",
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}

Updates a single user

Updates a given user

URL : /api/user/save

Method : PUT

Auth required : NO

Limit: Single user

Success Response

Code : 200 OK

Content examples

Example request:

{
    id: "b27e97f5-67e7-4883-9402-c7686da28f8b",
    email: "[email protected]",
    name: "Jim Smith",
    enabled: true,
    admin: true
}

Example response:

{
    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
    email: "[email protected]",
    name: "Jim Smith",
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}

Insert a new user

Inserts a new user

URL : /api/user/insert

Method : PUT

Auth required : YES

Limit: None

Success Response

Code : 200 OK

Content examples

Example request:

{
    email: "[email protected]",
    name: "Jim Smith"
}

Example response:

{
    id: "6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb",
    email: "[email protected]",
    name: "Jim Smith",
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}

Deletes existing article

Deletes an existing article content

URL : /api/user/delete/:id

Method : DELETE

Auth required : YES

Limit: None

Success Response

Code : 200 OK

Content examples

Example response:

{
    "success"
}