RESTSecurityInvoker Class

Security handler over the REST requests

Inheritance Hierarchy

System.Object
  System.Attribute
    CMS.WebServices.RESTSecurityInvoker

Namespace: CMS.WebServices
Assembly: CMS.WebServices (in CMS.WebServices.dll) Version: 8.2.23

Syntax

public class RESTSecurityInvoker : Attribute, 
	IOperationBehavior, IOperationInvoker

The RESTSecurityInvoker type exposes the following members.

Constructors

	Name	Description
Public method	RESTSecurityInvoker

Methods

	Name	Description
Public method	AddBindingParameters	Not needed, remains empty, does nothing.
Public method	AllocateInputs	Calls AllocateInputs on the invoker.
Public method	ApplyClientBehavior	Not needed, remains empty, does nothing.
Public method	ApplyDispatchBehavior	Initializes the invoker.
Public method	AuthenticateUser()	Authenticates the user according to authentication type setting.
Public method Static member	AuthenticateUser(String)	Authenticates the user according to authentication type setting.
Public method Static member	AuthenticateUserBasic	Authenticates the user using basic authentication.
Public method Static member	AuthenticateUserForms	Authenticates the user from the authentication cookie. If everything is ok returns name of the authenticated user. Otherwise returns null;
Public method Static member	GetAuthenticationType	Returns authentication type from settings.
Public method Static member	HandleRESTAuthentication	Handles necessary actions to provide proper REST authentication response
Public method Static member	CheckHash	Checks hash parameter. Returns true if the parameter matches the requested URL. For request different from GET returns alsways false.
Public method	Invoke	Invokes the operation only when authentication went well.
Public method	InvokeBegin	Not implemented method.
Public method	InvokeEnd	Not implemented method.
Public method	Validate	Not needed, remains empty, does nothing.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	HASH_AUTHENTICATED_USERNAME	Constant to identify the hash authentication requirement

Properties

	Name	Description
Public property	AuthenticationType	Gets the type of authentication which should be used to authenticate REST service. Default value is basic authentication ("basic" constant). Other option is forms authentication ("forms" constant).
Public property	DocumentAccessReadOnly	Indicates whether the access to the documents is read-only. If true, only GET reguests are allowed.
Public property	IsSynchronous	Always true - we need synchronous behaviour for authentication.
Public property	IsTranslation	Indicates whether the qeury is translation query.
Public property	ObjectAccessReadOnly	Indicates whether the access to the objects is read-only. If true, only GET reguests are allowed.
Public property	RESTServiceEnabled	Indicates whether the REST service is enabled (in settings).
Public property	ServiceTypeEnabled	Gets the type of the service which is enabled (0 = Everything, 1 = Only objects, 2 = Only documents).