API Reference
v3
Onli ID

Onli ID API

Onli_ID services are available for Appliance Developers on the Onli One Network that include: Authentication, Authorization and Accounting. Onli_ID works differently that the conventional user/password schema. An Onli_ID is computed not stored and compared. There is no password that is stored in a central database and compared to the one submitted. An Onli ID consists of a User Object and a Gene. Genes are stored in the Owner’s vault. Genes are a distinct sequence of base-pairs that store a unit of heredity which is transferred from one generation of Onli to another. Genes are tightly coupled to an Owner Object, which contain an email address, user data and the biometrics of a device.

Authenticate

Authenticate Owner is a Onli_ID RPC that authenticates owners on the Onli_One network using our patented authentication system. The RPC will send a notification to the owner via the OnliYou app. Owners control their Owner_Object and therefore there expressed permission must be requested to use their credentials. Authentication is an Onli_ID transaction and results in the editing of Genes.

Request

AttributeDescription
owneronli_you_id to authenticate
app_symbolName of appliance making request
app_keyOnli Cloud API Key

Response

AttributeDescription
authentication_statusAuthentication status message
auth_log_idTransaction ID from auth system
asset_balanceBalance of appliance assets in possession of owner

Example

Request - AuthenticateOwner
{
    "owner": "usr-xxx",
    "app_symbol": "ENGMA",
    "app_key": "hyu774"
}
Response AuthenticateOwner
{
    "authentication_status": true,
    "auth_log_id": "auth-log-528c7df4-880b-431b-8304-b816b183b935",
    "asset_balance": 987000
}

Context

MethodAuthenticateOwner
ObjectiveConfirm the identity of an Owner on the Onli One Network.
Requirementsonli_you_id app_symbol app_key
ContextOnli_ID API

Owners will receive an Authentication Request from their notifications on their Onli_You app. Upon acceptance and valid authentication, their appliance asset balance will also be returned. Owners are defined on the Onli_One network by their onli_you_id.

Authorize

A method which determines if the requestor has permission to use a resource and asks Owner for their authorization to execute said behavior. Authorization is an Onli_ID transaction and results in the editing of Genes.

Request

AttributeDescription
owneronli_you_id to authenticate
app_symbolName of appliance making request
app_keyOnli Cloud API Key
noteContains behavior check and body, personalized text for owner
note.behaviorbehavior askToMove is used for
note.bodymessage for owner

Response

AttributeDescription
behavior_statusCapabilities check: is user capable of executing behavior?
authentication_statusAuthentication status message
auth_log_idTransaction ID from auth system

Example

Request - AuthorizeBehavior
// Request
{
    "owner": "usr-xxx",
	"app_symbol": "ENGMA",
    "app_key": "hyu774",
    "note": {
		"behavior": "buy",
		"body": "Confirm purchase of 100M Enigma."
	}
}
Response - AuthorizeBehavior
// Response
{
    "behavior_status": true,
    "authorization_status": true,
    "auth_log_id": "auth-log-574f270b-cc96-4dde-acb2-b596611fd841"
}

Context

MethodAuthorizeBehavior
ObjectiveGet an owners data from the Onli_One Network
Requirementsonli_you_id app_symbol app_key note.behavior note.body
ContextOnli_ID API

Owners will receive an Authorization Request from their notifications on their Onli You app and confirm or deny. The Onli_ID service includes a note section to notify the Owner of the behavior being authorized and the context of the request in body. Owners are defined on the Onli_One network by their onli_you_id.

AuthLog

Owners possess an immutable chain of all transactions with their Gene stored in the Onli_ID AuthLog. This log is accounting method to gather request and response data from a specific appliance-owner Onli_ID event.

Request

AttributeDescription
auth_log_idauth_log_id of a past event
app_symbolName of appliance making request
app_keyOnli Cloud API Key

Response

AttributeDescription
auth_log_recordRequest and response data for specific auth_log_id

Example

Request - AuthLog
{
    "auth_log_id": "auth-log-id",
	"app_symbol": "ENGMA",
    "app_key": "hyu774"
}
Response - AuthLog
{
    "auth_log_record": Request { owner_id: "usr-123-456", note: { behavior: "buy", body: "Confirm purchase of 100M Enigma." }, "app_key": "app-auth", "app_symbol": "ENIGMA" } Response { "behavior_status": true, "authorization_status": true, "auth_log_id": "autho-123-456"}
}

Context

MethodAuthLog
ObjectiveRetrieve Event data from Onli_ID Services.
Requirementsonli_you_id app_symbol app_key
ContextOnli_ID API

Onli_ID Services maintains an immutable chain of all requests made to each Owner for appliance accounting purposes. Onli_You, the Owners appliance, maintains an immutable chain of all requests made to each Owner for appliance accounting purposes. AuthLog can be accessed by Appliance Developers.