Skip to content

Register and Login

Register

Register a user in FINUX

  • Method: POST
  • Path: /api/finux/users
  • Header: X-Fino-ClientID : clientID and X-Fino-ClientSecret : token

expected request:

{
  "email": "string",
  "password": "string",
  "repeatPassword": "string",
  "redirect_uri": "string",
  "lifespan": "int"
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "data": null,
    "code": 200
}

if the client not required user email verification

{
    "status": {
        "message": "OK"
    },
    "data": {
        "accessToken": "string",
        "expiresIn": "int",
        "refreshExpiresIn": "int",
        "refreshToken": "string",
        "tokenType": "string",
        "notBeforePolicy": "int",
        "sessionState": "string",
        "scope": "string"
    },
    "code": 200
}

custom errors:

{
    "status": {
        "message": "keyToi18nText"
    },
    "data": null,
    "code": 473
}

if email is not verified (update soon to keyToi18nText)

{
    "status":{
        "message": "400 Bad Request"
    },
    "data": null,
    "code": 403
}

Login

Returns an access- and refreshToken for valid and existing login-credentials

  • Method: POST
  • Path: /api/finux/auth
  • Header: X-Fino-ClientID : clientID and X-Fino-ClientSecret : token

expected request:

{
  "email": "string",
  "password": "string"
}

expected response:

{
    "status": {
        "message": "OK"
    },
    "data": {
        "accessToken": "string",
        "expiresIn": "int",
        "refreshExpiresIn": "int",
        "refreshToken": "string",
        "tokenType": "string",
        "notBeforePolicy": "int",
        "sessionState": "string",
        "scope": "string"
    },
    "code": 200
}

custom errors:

{
    "status": {
        "message": "keyToi18nText"
    },
    "data": null,
    "code": 473
}