This method is to generate a Cortex access token. Most of the methods of the Cortex API require this token as a parameter.

Application can specify the license key and the amount of sessions to be debited from the license and use them locally.

The token is linked to your application. It cannot be used with another application. The token is also linked to the EmotivID of the current user. It cannot be used with another EmotivID. So if the user logs out in EMOTIV Launcher, and then logs in with another EmotivID, your application must call this API again to get a new token.

Your application can save the Cortex token and reuse it later, within 2 days. Note that it is the responsibility of the application to secure the token.

If the user has not accepted the EULA, then a warning message will be included in the response as well. The user must accept the EULA through EMOTIV Launcher.

Parameters

Result

The result is an object containing a field cortexToken. It may also include a field warning, if the user didn't accept the EULA.

Examples

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "authorize",
    "params": {
        "clientId": "xxx",
        "clientSecret": "xxx"
    }
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "cortexToken":"xxx",
        "warning": {
            "code": 6,
            "message": "...",
            "licenseUrl": "https://..."
        }
    }
}

After your application is successfully connected to the Cortex service, you must go through the authentication procedure.

First, you should call getUserLogin to check if the user has already logged in though EMOTIV Launcher. Then, you must call requestAccess to ask the user to approve your application.

Finally, call authorize to generate a Cortex token or you can reuse a token that you previously got from this method, if it is not expired.

Request user approval for the current application through EMOTIV Launcher.

When your application calls this method for the first time, EMOTIV Launcher displays a message to approve your application. You can call this API many times, but EMOTIV Launcher will prompt the user only once. If the user has already approved your application, then this API does nothing.

Almost all the methods of the API require that your application was approved in EMOTIV Launcher. These methods will return an error if your application wasn't approved.

Parameters

Result

The result is an object containing a boolean value "accessGranted" and a message.

If accessGranted is false, then your application should ask the user to check EMOTIV Launcher and approve your application. Then you should wait for a while and call this API again. If accessGranted is true, then no action is required.

Examples

Application was already approved

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "requestAccess",
    "params": {
        "clientId": "xxx",
        "clientSecret": "xxx"
    }
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "accessGranted":true,
        "message":"The User has granted access right to this application."
    }
}

Application is not approved yet, or declined

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "requestAccess",
    "params": {
        "clientId": "xxx",
        "clientSecret": "xxx"
    }
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "accessGranted":false,
        "message":"The User has not granted access right to this application. Please use Emotiv App to proceed."
    }
}

This method returns information about the license currently used by your application.

Parameters

Result

The result is an object containing a license object and the isOnline flag.

Example

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "getLicenseInfo",
    "params": {
        "cortexToken": "xxx"
    }
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "isOnline":true,
        "license":{
            "applications":["com.emotiv.emotivpro"],
            "billingFrom":"2018-08-23T07:00:00.000+07:00",
            "billingTo":"2019-09-23T07:00:00.000+07:00",
            "deviceInfo":{
                "deviceLimit":15,
                "devicesPerSeat":3,
                "sessionLimit":{"day":null,"month":null,"year":null}
            },
            "expired":false,
            "extenderLimit":30,
            "hardLimitTime":"2019-07-01T06:59:59.999+07:00",
            "isCommercial":false,
            "licenseId":"xxx",
            "licenseName":"PRO license",
            "localQuota":0,
            "maxDebit":null,
            "scopes":["eeg","pm"],
            "seatCount":5,
            "sessionCount":0,
            "softLimitTime":"2019-06-24T06:59:59.999+07:00",
            "totalDebit":0,
            "totalRegisteredDevices":1,
            "validFrom":"2018-08-23T07:00:00.000+07:00",
            "validTo":"2019-09-24T06:59:59.999+07:00"
        }
    }
}

Check if your application has been granted access rights or not in EMOTIV Launcher.

Parameters

Result

The result is an object containing a boolean value "accessGranted" and a message.

If accessGranted is false, then your application should call requestAccess If accessGranted is true, then no action is required

Examples

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "hasAccessRight",
    "params": {
        "clientId": "xxx",
        "clientSecret": "xxx"
    }
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "accessGranted":true,
        "message":"The User has granted access right to this application."
    }
}

This method returns basic information about the current user.

Parameters

Result

The result is an object containing basic information about the user.

Examples

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "getUserInformation",
    "params": {
        "cortexToken": "xxx"
    }
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "username": "jon.snow",
        "firstName": "Jon",
        "lastName": "Snow",
        "licenseAgreement": {
            "accepted": true,
            "licenseUrl": "https://..."
        }
    }
}

Get the current logged in user.

Parameters

This method has no parameter.

Result

The result is an array of objects, each object describes a logged in user. If no user is logged in, then the result is an empty array.

Please note that currently, Cortex is a single user system. Only one user can login at a time, so the result contains at most one object.

The user object includes these fields:

If currentOSUId is equal to loggedInOSUId, then the user is already logged in and can work with Cortex. If currentOSUId is different from loggedInOSUId, then a user is logged into Cortex, but from a different OS account. So the user of the current OS account cannot work with Cortex, and must check EMOTIV Launcher.

Examples

No user is logged in

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "getUserLogin"
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": []
}

A user is logged in from the current OS account

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "getUserLogin"
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": [{
        "currentOSUId":"501",
        "currentOSUsername":"jsnow",
        "lastLoginTime": "2019-11-28T12:09:17.300+07:00",
        "loggedInOSUId":"501",
        "loggedInOSUsername":"jsnow",
        "username":"jon.snow"
    }]
}

A user is logged in from another OS account

The application is connected to Cortex that belongs to the OS account 501/jsnow. But someone has already logged in to Cortex from OS account 502/astark with the EmotivID aria.stark. So, the application cannot work with Cortex.

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "getUserLogin"
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": [{
        "currentOSUId":"501",
        "currentOSUsername":"jsnow",
        "lastLoginTime": "2019-11-28T12:09:17.300+07:00",
        "loggedInOSUId":"502",
        "loggedInOSUsername":"astark",
        "username":"aria.stark"
    }]
}

This method returns information about the Cortex service, like its version and build number.

Parameters

This method has no parameter.

Result

The result is an object with these fields:

Example

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "getCortexInfo"
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "buildDate":"2019-05-29T14:09:19",
        "buildNumber":"25cf08bd",
        "version":"2.0.0"
    }
}

This method uses a Cortex token to generate a new Cortex token. You can use this method to extend the expiration date of a token.

See authorize for details.

Parameters

Result

The result is an object containing a field cortexToken.

Example

{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "generateNewToken",
    "params": {
        "cortexToken": "xxx",
        "clientId": "...",
        "clientSecret": "..."
    }
}

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "cortexToken": "yyy"
    }
}