Class: IsActionAuthorisedRequest

tibco.objectapi.service.request.IsActionAuthorisedRequest

new IsActionAuthorisedRequest(component, action)

Object IsActionAuthorisedRequest Usage: RestApiService.getSecurityService().isActionAuthorised(request, callback);
Parameters:
Name Type Description
component string Identifier of the application component to which the named system action belongs.
action string The system action.
Since:
  • 4.0.0

Members

faultUnauth :boolean

Query parameter: 'faultonunauthorised' (optional, default=false) Boolean value indicating whether a service fault should be raised if any of the queried system actions are not authorised. If "false", an un-authorized system action is reported in the response.
Type:
  • boolean
Since:
  • 4.0.0
Default Value:
  • = false

performerGuid :string

Query parameter: 'performerentityguid' (optional) If the performer is identified in the request, this is the performer's GUID.
Type:
  • string
Since:
  • 4.0.0

performerType :string

Query parameter: 'performerentitytype' (optional) If the performer is identified in the request, this identifies the performer's entity type.
Type:
  • string
Since:
  • 4.0.0

scopeGuid :string

Query parameter: 'scopeentityguid' The GUID of the scoped organization model entity. Can be obtained using the getOrgModel function.
Type:
  • string
Since:
  • 4.0.0

scopeType :string

Query parameter: 'scopeentitytype' Enumerated value defining the scope of the organization model entity. The valid values are:
  • ORGANIZATIONAL_UNIT
  • GROUP
  • POSITION
Type:
  • string
Since:
  • 4.0.0

version :number

Query parameter: 'version' (Java type: int) (optional, default=-1): Major version number of the organization model in which an organization model entity resides. If not specified, the default value is the latest version of the organization model.
Type:
  • number
Since:
  • 4.0.0
Default Value:
  • = -1