2001: Authenticate

JSON data with type of authentication (native, facebook or onetime) along with data specific to type of authentication.

{
	"authType": "native",
	"loginID": "mailbox@mailserver.com",
	"password": "password"
}

{
	"authType": "facebook"
	"appID": 987654321,
	"userID": 123456789,
	"updatedAccessToken": "...",
	"accessTokenExpires": "..."
}

JSON data with key(s) for successfully authenticated account. The result will always hold the Rubiq entity ID and if the app making the request is configured to use a specific external key, this key is also included in the response. If authentication fails, the result is empty.

Responses to native and facebook authType requests resemble 1001: Create account response data:

{
    "id": 123456
    "name": "John Doe",
    "email": "mailbox@mailserver.com"
}

However authType: onetime responses may authenticate multiple entities, if they share the same loginID (e.g. email address), so onetype responses contain an array of entities, each with its own apiSessionKey property. There will not be an ApiSessionKey response header in a onetime authentication response. See Data Isolation for ApiSessionKey details.

{
    "entities": [
        {
            "id": 123456
            "name": "John Doe",
            "email": "shared@mailserver.com",
            "apiSessionKey": "x7s8t2lb9yi4ozswqkqurw3lh"
        },
        {
            "id": 234567
            "name": "Jane Doe",
            "email": "shared@mailserver.com",
            "apiSessionKey": "qxai81njm9jd2scb55rdftcbw"
        }
    ]
}