Authentication

Response will be a JSON object containing an access token and refresh token. You can ignore any other information in the response as this is not necessary for API usage.

Example response for valid access token:

Code
{
    "tokens":
    {
        "access_token": "value_here",
        "expires_at": 1656045319
    },
    "user":
    {
        "user_id": "auth0|XXX",
        "permissions": [
            "lumetric:access"
        ]
    }
}

Example response for expired access token + valid refresh token -> issues new access token

Code
{
    "tokens": {
        "access_token": "UPDATED_VALUE",
        "refresh_token": "VALUE", //not changed
        "expires_at": 1656091322 //new access token expiry
    },
    "user": {
        ...
    }
}

Example response for expired access token with no refresh token passed in body

This will not give a 200 response -- will return a 400 bad request error.

Code
{
    "error": "token is expired"
}

Response will be a JSON object containing an access token and refresh token. You can ignore any other information in the response as this is not necessary for API usage.

Example response for valid login

Code
{
    "tokens": {
        "access_token": "VALUE",
        "id_token": "VALUE", //ignore, not used for API requests
        "refresh_token": "VALUE",
        "expires_at": 1656091322 //access token expiry
    },
    "user": {
        "user_id": "auth0|XXXXXX", //your user ID in our system
        "permissions": [
            "lumetric:access"
        ],
        "email": "test@funnelflux.com",
        "email_verified": true,
        "name": "FunnelFlux Test User",
        "nickname": "test",
        "picture_url": "SOME_URL",
        "updated_at": 1655832122
    }
}