Authentication Information

An API client requests the authentication information for the connection as a textMessage (JSON format).

Request Interface

Parameter Name

Value

Required

Description

Default Value

type

string

true

Type of request (specify 'auth' for the authentication information)

 

apiKey

string

true

API key (specify your API key)

 

connectionId

string

true

Connection ID of a machine of which an API client issues a request

 

passwd

string

true

Connection Password of a machine of which an API client issues a request

 

ipFilterToken

string

false

Parameter that is needed when you use IP Filter. Be sure to specify this parameter when you set IP Filter to the Connection ID used for the connection. Specify the value into this parameter, that was generated by HULFT-WebConnect during handshake of WebSocket and returned for the response header 'x-webconnect-ipfilter-token' of the handshake.

 

client

object

true

Array of the elements described below

 

type

string

false

Client type (specify 'custom' for this field)

custom

agentId

string

true

Arbitrarily-registered ID that identifies an API client

 

hostName

string

true

Host name of an API client

 
Note

If you set IP Filter to the Connection ID used for the connection without adding 'ipFilterToken' to the API, the connection using the relevant Connection ID becomes unavailable.

Example

{
        "type":"auth",
        "apiKey":"abcdefg890abcdefg890abcdefg890ab",
        "connectionId":"webconnect",
        "passwd":"bh5A65r4Gar64",
        "ipFilterToken":"3e137062e6994595b571fb02a1324258",
        "client": {
                "type":"custom",
                "agentId":"example",
                "hostName":"example-host"
        }
}