element isActionAuthorised
diagram de_security_diagrams/de_security_p8.png
namespace http://security.api.de.n2.tibco.com
properties
content complex
children performer scope action
attributes
Name  Type  Use  Default  Fixed  Annotation
fault-on-unauthorised  xs:boolean    false    
documentation
Boolean value indicating whether a service fault should be raised if any of the queried system actions are not authorised. If "false" (the default), an un-authorised system action will be reported in the response.
annotation
documentation
Request element for isActionAuthorised operation.

This operation tests whether the caller (as identified by the SOAP security header) is authorized to perform the specified system actions within the scope of the specified organization model entity.

Each specified system action is tested individually.
source <xs:element name="isActionAuthorised">
 
<xs:annotation>
   
<xs:documentation>Request element for isActionAuthorised operation.

This operation tests whether the caller (as identified by the SOAP security header) is authorized to perform the specified system actions within the scope of the specified organization model entity.

Each specified system action is tested individually.
</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="performer" type="orgdto:XmlModelEntityId" minOccurs="0" maxOccurs="1">
       
<xs:annotation>
         
<xs:documentation>Optionally identifies an org-model entity, a resource, whose authorisation is to be tested. If not specified, the caller's authorisation is tested.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="scope" type="orgdto:XmlModelEntityId" minOccurs="0">
       
<xs:annotation>
         
<xs:documentation>Optionally, identifies the organization model entity upon which the System Action(s) is/are to be performed - the System Action scope.

Each listed system action will be tested for authorization within the scope of this organization model entity. If scope is not set, each system action will be tested for authorization against the complete organization model.
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="action" type="XmlSystemAction" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>Definition of a system action.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
   
<xs:attribute name="fault-on-unauthorised" type="xs:boolean" default="false">
     
<xs:annotation>
       
<xs:documentation>Boolean value indicating whether a service fault should be raised if any of the queried system actions are not authorised. If "false" (the default), an un-authorised system action will be reported in the response.</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
 
</xs:complexType>
</xs:element>

attribute isActionAuthorised/@fault-on-unauthorised
type xs:boolean
properties
default false
annotation
documentation
Boolean value indicating whether a service fault should be raised if any of the queried system actions are not authorised. If "false" (the default), an un-authorised system action will be reported in the response.
source <xs:attribute name="fault-on-unauthorised" type="xs:boolean" default="false">
 
<xs:annotation>
   
<xs:documentation>Boolean value indicating whether a service fault should be raised if any of the queried system actions are not authorised. If "false" (the default), an un-authorised system action will be reported in the response.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

element isActionAuthorised/performer
diagram de_security_diagrams/de_security_p9.png
type XmlModelEntityId
properties
minOcc 0
maxOcc 1
content complex
children dynamic-id-attr qualifierSet
attributes
Name  Type  Use  Default  Fixed  Annotation
model-version  xs:int  optional  -1    
documentation
Major version number of the organization model in which an organization model entity resides.

If not specified, the default value will be the latest version of the organization model.

(Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.)
entity-type  OrganisationalEntityType  required      
documentation
Enumerated value defining the type of the organization model entity.
guid  xs:string  required      
documentation
Globally unique ID of the organization model entity.

(Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.)
qualifier  xs:string  optional      
documentation
Only applicable in certain circumstances, and only to organization model entities whose entity-type is PRIVILEGE or CAPABILITY. These entities can have an association with other entities - for example, a resource may hold many capabilities, or a position may have many privileges.

These associations can have a qualifying value, according to their nature, to differentiate them. For example, the PRIVILEGE to sign off a purchase order may be qualified with the maximum amount that can be signed off.
annotation
documentation
Optionally identifies an org-model entity, a resource, whose authorisation is to be tested. If not specified, the caller's authorisation is tested.
source <xs:element name="performer" type="orgdto:XmlModelEntityId" minOccurs="0" maxOccurs="1">
 
<xs:annotation>
   
<xs:documentation>Optionally identifies an org-model entity, a resource, whose authorisation is to be tested. If not specified, the caller's authorisation is tested.</xs:documentation>
 
</xs:annotation>
</xs:element>

element isActionAuthorised/scope
diagram de_security_diagrams/de_security_p10.png
type XmlModelEntityId
properties
minOcc 0
maxOcc 1
content complex
children dynamic-id-attr qualifierSet
attributes
Name  Type  Use  Default  Fixed  Annotation
model-version  xs:int  optional  -1    
documentation
Major version number of the organization model in which an organization model entity resides.

If not specified, the default value will be the latest version of the organization model.

(Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.)
entity-type  OrganisationalEntityType  required      
documentation
Enumerated value defining the type of the organization model entity.
guid  xs:string  required      
documentation
Globally unique ID of the organization model entity.

(Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.)
qualifier  xs:string  optional      
documentation
Only applicable in certain circumstances, and only to organization model entities whose entity-type is PRIVILEGE or CAPABILITY. These entities can have an association with other entities - for example, a resource may hold many capabilities, or a position may have many privileges.

These associations can have a qualifying value, according to their nature, to differentiate them. For example, the PRIVILEGE to sign off a purchase order may be qualified with the maximum amount that can be signed off.
annotation
documentation
Optionally, identifies the organization model entity upon which the System Action(s) is/are to be performed - the System Action scope.

Each listed system action will be tested for authorization within the scope of this organization model entity. If scope is not set, each system action will be tested for authorization against the complete organization model.
source <xs:element name="scope" type="orgdto:XmlModelEntityId" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>Optionally, identifies the organization model entity upon which the System Action(s) is/are to be performed - the System Action scope.

Each listed system action will be tested for authorization within the scope of this organization model entity. If scope is not set, each system action will be tested for authorization against the complete organization model.
</xs:documentation>
 
</xs:annotation>
</xs:element>

element isActionAuthorised/action
diagram de_security_diagrams/de_security_p11.png
type XmlSystemAction
properties
minOcc 1
maxOcc unbounded
content complex
attributes
Name  Type  Use  Default  Fixed  Annotation
component  xs:string  required      
documentation
Identifier of the application component to which the named system action belongs.

See "System Actions" in the BPM Developer's Guide for a list of system actions and their parent component identifiers.
name  xs:string  required      
documentation
Name of the system action.

See "System Actions" in the BPM Developer's Guide for a list of system actions and their parent component identifiers.
annotation
documentation
Definition of a system action.
source <xs:element name="action" type="XmlSystemAction" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Definition of a system action.</xs:documentation>
 
</xs:annotation>
</xs:element>


XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy