Type alias ReqInfo

This structure represents the expected authn/z info attached to any request made against the system. Keys are as follows:

t = "set" system (see below) c = clientId a = authenticated (i.e., provided a valid secret key) r = client roles ip = ip address from which the request originated d = "debug mode" - This indicates that a valid debug key was passed and that debugging features should be made available u.sid = session id u.id = user id u.r = user roles u.s = An optional array of scopes granted via oauth. If null or undefined, then this is a direct user request and not an oauth request.

Note that roles and scopes may be strings (e.g., "sysadmin", "employee", etc...) or numbers representing bitwise values. You must specify which system you are using using the t parameter, where 0 means Arrays of strings and 1 means bitwise numbers.

TODO: OAUTH IS NOT A WELL DEFINED CONCEPT FOR THIS LIBRARY RIGHT NOW. EVENTUALLY IT WILL LIKELY BE BROKEN OUT INTO ITS OWN SEGMENT OF THE REQINFO OBJECT, BUT WE'RE NOT GOING TO WORRY ABOUT IT FOR NOW.

Generated using TypeDoc