Skip to main content

HSMOD.Authentication.RESTSession.API

class HSMOD.Authentication.RESTSession.API extends HSMOD.REST.Base

base class for applications to derive a REST authentication API. If there are any additions to the UrlMap, the UrlMap XData block should be copied into the subclass and added to.

@API.Extensible

Method Inventory

Parameters

parameter ALLOWUNKNOWNUSER = 0;

default behavior is to disallow unknown users. Subclasses can override this.

@API.Parameter @API.Overrideable
parameter CONTENTTYPE = application/json;
@API.Parameter

Methods

classmethod CreateStatusResponse(Output pNewStatusObject As HSMOD.Authentication.RESTSession.Auxil.UserStatus) as %Status

callback for instantiating the response object to be returned by UserStatus(). Can be overridden if an extension class needs to return a subclass of HSMOD.Authentication.RESTSession.Auxil.UserStatus.

@API.Overrideable
classmethod PopulateCustomStatusData(pWorkingStatusObject As HSMOD.Authentication.RESTSession.Auxil.UserStatus) as %Status

Callback method for subclasses to override if any extra handling needs to be applied to the output status object for UserStatus(). This is called by the UserStatus method after populating standard properties of the response object, but before serializing to JSON.

@API.Overrideable
classmethod UserLogin() as %Status
Method to be executed after a user successfully reaches the /login resource. Note that reaching this method implies that the user is already logged in.
classmethod UserLogout() as %Status
End the current user session
classmethod UserStatus() as %Status
user status API method. No inputs. Output is a JSON representation of a HSMOD.UserAdmin.RestAPI.Auxil.UserStatus object.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab