ComexposiumConnect

🔦 Check user token

This route will compared the email to the JWT Token in the backend. Allowed fields to be modified

Description

ENDPOINT DESCRIPTION METHOD EXEMPLE
/_plugin/Comexposium/user/checkUserToken Check if the JWT is based on the email given in parameter POST https://api.preprod.comexposium-sso.com/_login

Body

{
  "email": "[email protected]"
}

Call Exemple

curl -X POST "https://api.preprod.comexposium-sso.com/_plugin/Comexposium/user/checkUserToken" -H "accept: application/json" -H "Authorization: Bearer myBearerToken" -H "content-type: application/json" -d "{ \"email\": \"[email protected]\"}"

Details

Responses

You can only get a 200 or 401 status code by using this endpoint, you will find results in the statusCode attribute .

Success

statusCode: 0, message: generic_success, data: { isValid: true / false

Exemple:

{
  "requestId": "c4815bc2-5bbb-42e7-a190-def577acdfba",
  "status": 200,
  "error": null,
  "controller": "Comexposium/userController",
  "action": "checkUserToken",
  "collection": null,
  "index": null,
  "volatile": null,
  "result": {
    "statusCode": 0,
    "message": "generic_success",
    "data": {
      "isValid": false
    }
  }
}

Errors

statusCode: 201: Missing credentials

statusCode: 202: Internal error

status: 401: Json Web Token Error

Exemple:

{
  "requestId": "be89a1ac-e45a-416c-a01c-f79c138656db",
  "status": 401,
  "error": {
    "message": "Json Web Token Error",
    "status": 401,
    "stack": "UnauthorizedError: Json Web Token Error\n    at UnauthorizedError (/opt/kuzzle/node_modules/kuzzle-common-objects/lib/errors/unauthorizedError.js:5:5)\n    at TokenRepository.verifyToken (/opt/kuzzle/lib/api/core/models/repositories/tokenRepository.js:152:17)\n    at FunnelController.checkRights (/opt/kuzzle/lib/api/controllers/funnelController.js:316:43)\n    at FunnelController.execute (/opt/kuzzle/lib/api/controllers/funnelController.js:218:10)\n    at kuzzle.pluginsManager.trigger.then.mutatedRequest (/opt/kuzzle/lib/api/controllers/routerController.js:146:28)\n    at tryCatcher (/opt/kuzzle/node_modules/bluebird/js/release/util.js:16:23)\n    at Promise._settlePromiseFromHandler (/opt/kuzzle/node_modules/bluebird/js/release/promise.js:512:31)\n    at Promise._settlePromise (/opt/kuzzle/node_modules/bluebird/js/release/promise.js:569:18)\n    at Promise._settlePromise0 (/opt/kuzzle/node_modules/bluebird/js/release/promise.js:614:10)\n    at Promise._settlePromises (/opt/kuzzle/node_modules/bluebird/js/release/promise.js:693:18)\n    at Async._drainQueue (/opt/kuzzle/node_modules/bluebird/js/release/async.js:133:16)\n    at Async._drainQueues (/opt/kuzzle/node_modules/bluebird/js/release/async.js:143:10)\n    at Immediate.Async.drainQueues (/opt/kuzzle/node_modules/bluebird/js/release/async.js:17:14)\n    at runCallback (timers.js:637:20)\n    at tryOnImmediate (timers.js:610:5)\n    at processImmediate [as _immediateCallback] (timers.js:582:5)"
  },
  "controller": "Comexposium/userController",
  "action": "checkUserToken",
  "collection": null,
  "index": null,
  "volatile": null,
  "result": null
}

← 📡 Get all user types →