Core
Framework v2.x
2

RequestContext #

Kuzzle execution context for the request.

Contains informations about identity (token, user) and origin (connection).

connection #

TypeDescriptionget / set
Connection
Information about the connection at the origin of the request.get

Connection properties #

NameTypeDescriptionget / set
id
string
Unique identifier of the user connectionget
protocol
string
Network protocol nameget
ips
string[]
Chain of IP addresses, starting from the clientget
misc
ContextMisc
Additional informations about the connectionget

ContextMisc HTTP informations #

NameTypeDescriptionget / set
path
string
HTTP pathget
verb
string
HTTP verbget
headers
string
HTTP headersget

token #

TypeDescriptionget / set
Token
Authentication tokenget

Token properties #

NameTypeDescriptionget / set
_id
string
Unique IDget
expiresAt
number
Expiration date in Epoch-microget
ttl
number
Time-to-liveget
userId
string
Associated user IDget
connectionId
string
Associated connection IDget
jwt
string
JWT tokenget
refreshed
boolean
True if the token has been refreshed with the current requestget

user #

TypeDescriptionget / set
User
Associated userget

User properties #

The User class extends the JSONObject class and can contain other properties.

NameTypeDescriptionget / set
_id
string
Unique IDget
profileIds
string[]
User profilesget