User accounts

All endpoints that are created for managing user accounts.

Create a new user in the database & Api Key.

POST https://dev.bol.mintycloud.nl/api/v1/accounts/user

This endpoint creates a new user into the database and adds an API Key. New accounts will have the roleType demo_client by default. This may be changed with other endpoints.

Request Body

Name	Type	Description
email*	String	Email name
verified	Boolean	User verified of unverified

200: OK Created successfully user account

{
    "userId": 1,
    "apiKey": "c8e8db4743daa0d616c842bb164f5c154a1521ce9db6e5db165bf26e786c6c5c"
}

400: Bad Request Email field is required.

{
    "error": "Email field is required for creating new accounts."
}

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

Get all users

GET https://dev.bol.mintycloud.nl/api/v1/accounts/user

This endpoint is used for getting all users from the database.

200: OK

[
    {
        "userId": 1,
        "verified": 1,
        "email": "[e-mail]",
        "roleType": "demo_client",
        "licenseKey": "261caef326f21d109c90486719cfdea2",
        "licenseIsActive": 1,
        "licenseExpiryDate": "2022-11-23T13:03:35.789Z",
        "createdAt": "2022-09-09T13:03:35.789Z",
        "errorCount": 5,
        "lastError": "2022-09-09T14:08:26.704Z"
    },
    {
        "userId": 2,
        "verified": 0,
        "email": "[e-mail]",
        "roleType": "demo_client",
        "licenseKey": "2e1d92e4233b32cc22def66d0abe497b",
        "licenseIsActive": 1,
        "licenseExpiryDate": "2022-10-05T10:41:35.877Z",
        "createdAt": "2022-09-21T10:41:35.877Z",
        "errorCount": 0,
        "lastError": null
    },
    {
        "userId": 3,
        "verified": 0,
        "email": "[e-mail]",
        "roleType": "demo_client",
        "licenseKey": "e771197d1bd4a3c3f702d5799e562269",
        "licenseIsActive": 1,
        "licenseExpiryDate": "2022-10-05T14:48:23.395Z",
        "createdAt": "2022-09-21T14:48:23.395Z",
        "errorCount": 0,
        "lastError": null
    }
]

401: Unauthorized Incorrect API Key

{
    // Response
}

500: Internal Server Error Database error

{
    // Response
}

Get an existing user.

GET https://dev.bol.mintycloud.nl/api/v1/accounts/user/:userId

Get a user by their identifier.

Path Parameters

Name	Type	Description
userId*	Number	User identifier

200: OK

{
    "userId": 1,
    "verified": 1,
    "email": "[e-mail]",
    "roleType": "demo_client",
    "licenseKey": "361caef336f21c109c90486719cfdea2",
    "licenseIsActive": 1,
    "licenseExpiryDate": "2022-11-23T13:03:35.789Z",
    "createdAt": "2022-09-09T13:03:35.789Z",
    "errorCount": 5,
    "lastError": "2022-09-09T14:08:26.704Z"
}

400: Bad Request User not found

{
    "error": "User not found."
}

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

Update an existing user.

PUT https://dev.bol.mintycloud.nl/api/v1/accounts/user/:userId

Update user information.

Path Parameters

Name	Type	Description
userId*	Number	User identifier

Request Body

Name	Type	Description
email	String	Set user's email
verified	Boolean	Verified or unverified
roleType	Enum	'admin', 'verified_client', 'demo_client'
licenseIsActive	Boolean	Set the license true or false (active or inactive)
addError	Number	Add number to the error count.
licenseExpiryDate	String	Date string

200: OK Updated account successfully

{
    "message": "User 1 updated."
}

400: Bad Request No data provided.

{
    "error": "No data provided."
}

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

400: Bad Request No valid data provided.

{
    "error": "No valid data provided."
}

404: Not Found Didn't update any user information.

{
    "error": "Didn't update any user information."
}

Delete an existing user.

DELETE https://dev.bol.mintycloud.nl/api/v1/accounts/user/:userId

Delete user information.

Path Parameters

Name	Type	Description
userId*	Number	User identifier

204: No Content Deleted account successfully.

401: Unauthorized Incorrect API key

500: Internal Server Error Database error

404: Not Found User not found.

{
    "error": "User not found."
}