Class
auth
lucee.Component
coldbox.system.FrameworkSupertype
coldbox.system.EventHandler
coldbox.system.RestHandler
cborm.models.resources.BaseHandler
contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.baseHandler
contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.auth
ContentBox API Authentication handler
Class Attributes:
synchronized
: false
accessors
: false
persistent
: false
Property Summary
|
type
|
property
|
default
|
serializable
|
required
|
any
|
securityService
- access = public
- returntype = any
- inject = securityService@contentbox
|
|
true
|
false
|
Method Summary
|
any
|
login([any event], [any rc], [any prc])
Login to ContentBox and get your JWT Token.
|
any
|
logout([any event], [any rc], [any prc])
Logout from ContentBox, you must pass in your JWT Token else we don't know who you are :).
|
any
|
refreshToken([any event], [any rc], [any prc])
Refresh your access token, you must pass in your JWT Refresh token.
|
any
|
whoami([any event], [any rc], [any prc])
If logged in, you will be able to see your user information.
|
Methods inherited from class contentbox.modules.contentbox-api.modules.contentbox-api-v1.handlers.baseHandler
|
autoCast, create, delete, getByIdOrSlugOrFail, getMaxRows, getPageOffset, getSiteByIdOrSlugOrFail, index, newCriteria, show, update
|
Methods inherited from class cborm.models.resources.BaseHandler
|
None
|
Methods inherited from class coldbox.system.RestHandler
|
aroundHandler, onAnyOtherException, onAuthenticationFailure, onAuthorizationFailure, onEntityNotFoundException, onError, onExpectationFailed, onInvalidHTTPMethod, onInvalidRoute, onMissingAction, onValidationException
|
Methods inherited from class coldbox.system.FrameworkSupertype
|
announce, announceInterception, async, back, externalView, forAttribute, getCache, getCachebox, getColdBoxSetting, getController, getDateTimeHelper, getEnv, getFlash, getFlow, getInstance, getIsoTime, getJsonUtil, getLog, getLogBox, getModuleConfig, getModuleSettings, getRenderer, getRequestCollection, getRequestContext, getRootWireBox, getSetting, getSystemProperty, getSystemSetting, getUserSessionIdentifier, getWirebox, ifNull, ifPresent, inDebugMode, includeUDF, isDevelopment, isProduction, isTesting, layout, listen, loadApplicationHelpers, locateDirectoryPath, locateFilePath, persistVariables, populate, populateModel, relocate, renderExternalView, renderLayout, renderview, runEvent, runRoute, setCachebox, setController, setEnv, setFlash, setFlow, setJsonUtil, setLog, setLogBox, setSetting, setWirebox, settingExists, throwIf, throwUnless, toJson, unless, view, when
|
Methods inherited from class lucee.Component
|
None
|
securityService
property any
securityService
- Attributes:
access
- public
required
- false
returntype
- any
inject
- securityService@contentbox
serializable
- true
login
public any login([any event], [any rc], [any prc])
Login to ContentBox and get your JWT Token
- Parameters:
event
rc
prc
logout
public any logout([any event], [any rc], [any prc])
Logout from ContentBox, you must pass in your JWT Token else we don't know who you are :)
- Parameters:
event
rc
prc
refreshToken
public any refreshToken([any event], [any rc], [any prc])
Refresh your access token, you must pass in your JWT Refresh token
- Parameters:
event
rc
prc
whoami
public any whoami([any event], [any rc], [any prc])
If logged in, you will be able to see your user information.
- Parameters:
event
rc
prc