API

This is a test.

Authenticate a user

post

Authenticate a user

Body

application/json

emailstringRequired

passwordstringRequired

Responses

200

OK

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

/v1/auth

HTTPcURLJavaScriptPython

POST /v1/auth HTTP/1.1
Host: localhost:8010
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "email": "text",
  "password": "text"
}

{
  "code": 1,
  "error": "text",
  "message": "text",
  "token": "text",
  "user": {
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": "text",
    "email": "text",
    "firstname": "text",
    "lastname": "text",
    "roles": [
      {
        "description": "text",
        "role": "text"
      }
    ],
    "user_id": "text"
  }
}

Register a new account using a password

post

Register a new account using a password

Body

application/json

emailstringRequired

first_namestringRequired

last_namestringRequired

passwordstringRequired

Responses

200

OK

application/json

422

Unprocessable Entity

application/json

post

/v1/register

HTTPcURLJavaScriptPython

POST /v1/register HTTP/1.1
Host: localhost:8010
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "email": "text",
  "first_name": "text",
  "last_name": "text",
  "password": "text"
}

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "code": 1,
  "created_at": "text",
  "email": "text",
  "error": "text",
  "firstname": "text",
  "lastname": "text",
  "message": "text",
  "roles": [
    {
      "description": "text",
      "role": "text"
    }
  ],
  "user_id": "text"
}

Validate a registration token

get

Validate a registration token

Path parameters

tokenstringRequired

Token

Responses

200

OK

application/json

401

Unauthorized

application/json

get

/v1/register/validate/{token}

HTTPcURLJavaScriptPython

GET /v1/register/validate/{token} HTTP/1.1
Host: localhost:8010
Accept: */*

{
  "code": 1,
  "error": "text",
  "message": "text"
}

Get user details

get

Get the details of the currently logged-in user

Responses

200

OK

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/v1/user/me

HTTPcURLJavaScriptPython

GET /v1/user/me HTTP/1.1
Host: localhost:8010
Accept: */*

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "code": 1,
  "created_at": "text",
  "email": "text",
  "error": "text",
  "firstname": "text",
  "lastname": "text",
  "message": "text",
  "roles": [
    {
      "description": "text",
      "role": "text"
    }
  ],
  "user_id": "text"
}

Update user details

patch

Update the details of the currently logged-in user

Body

application/json

emailstringRequired

firstnamestringRequired

lastnamestringRequired

Responses

200

OK

application/json

500

Internal Server Error

application/json

patch

/v1/user/me

HTTPcURLJavaScriptPython

PATCH /v1/user/me HTTP/1.1
Host: localhost:8010
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "email": "text",
  "firstname": "text",
  "lastname": "text"
}

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "code": 1,
  "created_at": "text",
  "email": "text",
  "error": "text",
  "firstname": "text",
  "lastname": "text",
  "message": "text",
  "roles": [
    {
      "description": "text",
      "role": "text"
    }
  ],
  "user_id": "text"
}

Update the password of the currently logged-in user

patch

Update the password of the currently logged-in user

Body

application/json

new_passwordstringRequired

old_passwordstringRequired

Responses

200

OK

application/json

401

Unauthorized

application/json

patch

/v1/user/me/password

HTTPcURLJavaScriptPython

PATCH /v1/user/me/password HTTP/1.1
Host: localhost:8010
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "new_password": "text",
  "old_password": "text"
}

{
  "code": 1,
  "error": "text",
  "message": "text"
}