Core
Framework v2.x
2

RequestContext #

Kuzzle execution context for the request.

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

connection #

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

Connection properties #

Name Type Description get / set
id
string
Unique identifier of the user connection get
protocol
string
Network protocol name get
ips
string[]
Chain of IP addresses, starting from the client get
misc
ContextMisc
Additional informations about the connection get

ContextMisc HTTP informations #

Name Type Description get / set
path
string
HTTP path get
verb
string
HTTP verb get
headers
string
HTTP headers get

token #

Type Description get / set
Token
Authentication token get

Token properties #

Name Type Description get / set
_id
string
Unique ID get
expiresAt
number
Expiration date in Epoch-micro get
ttl
number
Time-to-live get
userId
string
Associated user ID get
connectionId
string
Associated connection ID get
jwt
string
JWT token get
refreshed
boolean
True if the token has been refreshed with the current request get

user #

Type Description get / set
User
Associated user get

User properties #

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

Name Type Description get / set
_id
string
Unique ID get
profileIds
string[]
User profiles get