Authentication
Once a websocket connection is established, access to the majority of API methods is provided only to authenticated clients with the appropriate entitlements.
In order to authenticate the client connection, submit the “auth” request.
When the client is finished with the connection, the connection can be closed and the client will be logged out automatically. In order to logout the connection explicitly, submit the “logout” request.
Authenticate
Authenticate connection with authentication token.
Request method
auth
Parameters
| Field | Type | Description |
|---|---|---|
| token | string | An access token, provided by Etana Support, to access the API. |
| id_token | string | (optional) id token provided by authentication service. |
string | (optional) email provided by authentication service. |
Response
| Field | Type | Description |
|---|---|---|
| user_id | string | The platform user identifier for this user. |
| login_id | string | The platform login identifier for this user. |
Logout
Drop the authentication credentials.
Request method
logout
Parameters
none
Response
none