%pkg.isc.rest.authentication
abstract class %pkg.isc.rest.authentication extends %Library.RegisteredObject
Interface for authentication methods used in subclasses of %pkg.isc.rest.handler NOTE: All methods have *WithDispatch equivalents. If the WithDispatch equivalents are implemented, they are executed instead. These provide the callback with an additional argument of the dispatch class.Method Inventory
- Authenticate()
- AuthenticateWithDispatch()
- CheckPermission()
- CheckPermissionWithDispatch()
- Logout()
- LogoutWithDispatch()
- UserInfo()
- UserInfoWithDispatch()
Methods
Implement to define custom authentication logic that will be run OnPreDispatch.
If pContinue is set to false, the request will not be dispatched.
abstract classmethod AuthenticateWithDispatch(pDispatchClass As %Dictionary.Classname, pUrl As %String, ByRef pContinue As %Boolean) as %Status
Equivalent to Authenticate() with additional argument DispatchClass
of the calling dispatch class.
abstract classmethod CheckPermission(pResourceClassName As %Dictionary.Classname, pOperation As %String, pUserContext As %RegisteredObject) as %Boolean
Allows centralized control over permission checking,
which is applied *in addition* to resource-level permission checks.
If unimplemented, only resource-level checks are used.
For a granular permission-based scheme, see %pkg.isc.rest.authorization.permission.
abstract classmethod CheckPermissionWithDispatch(pDispatchClass As %Dictionary.Classname, pResourceClassName As %Dictionary.Classname, pOperation As %String, pUserContext As %RegisteredObject) as %Boolean
Equivalent to CheckPermission() with additional argument DispatchClass
of the calling dispatch class.
abstract classmethod Logout() as %Status
Invoked when /auth/logout is called.
abstract classmethod LogoutWithDispatch(pDispatchClass As %Dictionary.Classname) as %Status
Equivalent to Logout() with additional argument DispatchClass
of the calling dispatch class.
abstract classmethod UserInfo(Output pUserInfo As %DynamicObject) as %Status
Returns authenticated user information for the request or session
abstract classmethod UserInfoWithDispatch(pDispatchClass As %Dictionary.Classname, Output pUserInfo As %DynamicObject) as %Status
Equivalent to UserInfo() with additional argument DispatchClass
of the calling dispatch class.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()