Skip to content

AccessControl

AccessControl service implementation.

AccessControl

Bases: ONVIFService

0.0.1 2.3

AccessControl service client.

Property Details
First introduced ONVIF 2.3 (May 2013)
Binding name PACSBinding (ver10/pacs/accesscontrol.wsdl)
Operations accesscontrol.wsdl
Spec AccessControl

GetServiceCapabilities 

GetServiceCapabilities()

This operation returns the capabilities of the access control service.

A device which provides the access control service shall implement this method.

Output
  • Capabilities [ServiceCapabilities]
    The capability response message contains the requested Access Control service capabilities using a hierarchical XML capability structure.
    • MaxLimit - required; [unsignedInt]
      The maximum number of entries returned by a single Get<Entity>List or Get<Entity> request. The device shall never return more than this number of entities in a single response.
    • MaxAccessPoints - optional; [unsignedInt]
      Indicates the maximum number of access points supported by the device.
    • MaxAreas - optional; [unsignedInt]
      Indicates the maximum number of areas supported by the device.
    • ClientSuppliedTokenSupported - optional; [boolean]
      Indicates that the client is allowed to supply the token when creating access points and areas. To enable the use of the commands SetAccessPoint and SetArea, the value must be set to true.
    • AccessPointManagementSupported - optional; [boolean]
      Indicates that the client can perform CRUD operations (create, read, update and delete) on access points. To enable the use of the commands GetAccessPoints, GetAccessPointList, CreateAccessPoint, ModifyAccessPoint, DeleteAccessPoint, SetAccessPointAuthenticationProfile and DeleteAccessPointAuthenticationProfile, the value must be set to true.
    • AreaManagementSupported - optional; [boolean]
      Indicates that the client can perform CRUD operations (create, read, update and delete) on areas. To enable the use of the commands GetAreas, GetAreaList, CreateArea, ModifyArea and DeleteArea, the value must be set to true.

GetAccessPointInfoList 

GetAccessPointInfoList(Limit=None, StartReference=None)

This operation requests a list of all AccessPointInfo items provided by the device.

A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer to section 4.8.3 in [ONVIF PACS Architecture and Design Considerations] for more details. The number of items returned shall not be greater than the Limit parameter.

Input
  • Limit - optional; [int]
    Maximum number of entries to return. If not specified, less than one or higher than what the device supports, the number of items is determined by the device.
  • StartReference - optional; [string]
    Start returning entries from this start reference. If not specified, entries shall start from the beginning of the dataset.
Output
  • NextStartReference - optional; [string]
    StartReference to use in next call to get the following items. If absent, no more items to get.
  • AccessPointInfo - optional, unbounded; [AccessPointInfo]
    List of AccessPointInfo items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      Optional user readable description for the AccessPoint. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • AreaFrom - optional; [ReferenceToken]
      Optional reference to the Area from which access is requested.
      Minimum length: 0
      Maximum length: 64
    • AreaTo - optional; [ReferenceToken]
      Optional reference to the Area to which access is requested.
      Minimum length: 0
      Maximum length: 64
    • EntityType - optional; [QName]
      Optional entity type; if missing, a Door type as defined by [ONVIF Door Control Service Specification] should be assumed. This can also be represented by the QName value "tdc:Door" – where tdc is the namespace of the door control service: "http://www.onvif.org/ver10/doorcontrol/wsdl". This field is provided for future extensions; it will allow an access point being extended to cover entity types other than doors as well.
    • Entity [ReferenceToken]
      Reference to the entity used to control access; the entity type may be specified by the optional EntityType field explained below but is typically a Door.
      Minimum length: 0
      Maximum length: 64
    • Capabilities [AccessPointCapabilities]
      The capabilities for the AccessPoint.
      • DisableAccessPoint - required; [boolean]
        Indicates whether or not this AccessPoint instance supports EnableAccessPoint and DisableAccessPoint commands.
      • Duress - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of duress events.
      • AnonymousAccess - optional; [boolean]
        Indicates whether or not this AccessPoint has a REX switch or other input that allows anonymous access.
      • AccessTaken - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of AccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it indicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported.
      • ExternalAuthorization - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports the ExternalAuthorization operation and the generation of Request events. If AnonymousAccess and ExternalAuthorization are both true, it indicates that the Anonymous version is supported as well.
      • SupportedRecognitionTypes - optional; [StringList]
        A list of recognition types that the device supports. This field is only relevant for devices that are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]). Please note that when an access point is updated, then any previously supported recognition types are replaced with the new list. Recognition types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in pt:RecognitionType. For custom defined identifier types, free text can be used.
      • IdentifierAccess - optional; [boolean]
        Indicates whether or not this access point supports the AccessControl/Request/Identifier event to request external authorization. Identfier access requires that ExternalAuthorization is set to true. The IdentifierAccess capability is typically enabled for devices that do not have any knowledge of credential tokens. When IdentifierAccess is set to true then the device must support the identifier events.
      • SupportedFeedbackTypes - optional; [StringList]
        List of supported feedback types. Feedback types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in tac:FeedbackType. For custom defined feedback types, free text can be used.
      • SupportedSecurityLevels - optional, unbounded; [ReferenceToken]
        A list of security level tokens that this access point supports. See [Authentication Behavior Service Specification]. This field is optional, and if omitted, the device cannot support multi-factor authentication for this access point. Please note that when an access point is updated, then any previously supported security levels are replaced with the new list.
        Minimum length: 0
        Maximum length: 64
      • Extension - optional; [SupportedSecurityLevelsExtension]

GetAccessPointInfo 

GetAccessPointInfo(Token)

This operation requests a list of AccessPointInfo items matching the given tokens.

The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.

Input
  • Token - unbounded; [ReferenceToken]
    Tokens of AccessPointInfo items to get.
    Minimum length: 0
    Maximum length: 64
Output
  • AccessPointInfo - optional, unbounded; [AccessPointInfo]
    List of AccessPointInfo items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      Optional user readable description for the AccessPoint. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • AreaFrom - optional; [ReferenceToken]
      Optional reference to the Area from which access is requested.
      Minimum length: 0
      Maximum length: 64
    • AreaTo - optional; [ReferenceToken]
      Optional reference to the Area to which access is requested.
      Minimum length: 0
      Maximum length: 64
    • EntityType - optional; [QName]
      Optional entity type; if missing, a Door type as defined by [ONVIF Door Control Service Specification] should be assumed. This can also be represented by the QName value "tdc:Door" – where tdc is the namespace of the door control service: "http://www.onvif.org/ver10/doorcontrol/wsdl". This field is provided for future extensions; it will allow an access point being extended to cover entity types other than doors as well.
    • Entity [ReferenceToken]
      Reference to the entity used to control access; the entity type may be specified by the optional EntityType field explained below but is typically a Door.
      Minimum length: 0
      Maximum length: 64
    • Capabilities [AccessPointCapabilities]
      The capabilities for the AccessPoint.
      • DisableAccessPoint - required; [boolean]
        Indicates whether or not this AccessPoint instance supports EnableAccessPoint and DisableAccessPoint commands.
      • Duress - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of duress events.
      • AnonymousAccess - optional; [boolean]
        Indicates whether or not this AccessPoint has a REX switch or other input that allows anonymous access.
      • AccessTaken - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of AccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it indicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported.
      • ExternalAuthorization - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports the ExternalAuthorization operation and the generation of Request events. If AnonymousAccess and ExternalAuthorization are both true, it indicates that the Anonymous version is supported as well.
      • SupportedRecognitionTypes - optional; [StringList]
        A list of recognition types that the device supports. This field is only relevant for devices that are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]). Please note that when an access point is updated, then any previously supported recognition types are replaced with the new list. Recognition types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in pt:RecognitionType. For custom defined identifier types, free text can be used.
      • IdentifierAccess - optional; [boolean]
        Indicates whether or not this access point supports the AccessControl/Request/Identifier event to request external authorization. Identfier access requires that ExternalAuthorization is set to true. The IdentifierAccess capability is typically enabled for devices that do not have any knowledge of credential tokens. When IdentifierAccess is set to true then the device must support the identifier events.
      • SupportedFeedbackTypes - optional; [StringList]
        List of supported feedback types. Feedback types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in tac:FeedbackType. For custom defined feedback types, free text can be used.
      • SupportedSecurityLevels - optional, unbounded; [ReferenceToken]
        A list of security level tokens that this access point supports. See [Authentication Behavior Service Specification]. This field is optional, and if omitted, the device cannot support multi-factor authentication for this access point. Please note that when an access point is updated, then any previously supported security levels are replaced with the new list.
        Minimum length: 0
        Maximum length: 64
      • Extension - optional; [SupportedSecurityLevelsExtension]

GetAccessPointList 

GetAccessPointList(Limit=None, StartReference=None)

This operation requests a list of all AccessPoint items provided by the device.

A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than the Limit parameter.

Input
  • Limit - optional; [int]
    Maximum number of entries to return. If not specified, less than one or higher than what the device supports, the number of items is determined by the device.
  • StartReference - optional; [string]
    Start returning entries from this start reference. If not specified, entries shall start from the beginning of the dataset.
Output
  • NextStartReference - optional; [string]
    StartReference to use in next call to get the following items. If absent, no more items to get.
  • AccessPoint - optional, unbounded; [AccessPoint]
    List of AccessPoint items.
    • Capabilities [AccessPointCapabilities]
      The capabilities for the AccessPoint.
      • DisableAccessPoint - required; [boolean]
        Indicates whether or not this AccessPoint instance supports EnableAccessPoint and DisableAccessPoint commands.
      • Duress - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of duress events.
      • AnonymousAccess - optional; [boolean]
        Indicates whether or not this AccessPoint has a REX switch or other input that allows anonymous access.
      • AccessTaken - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of AccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it indicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported.
      • ExternalAuthorization - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports the ExternalAuthorization operation and the generation of Request events. If AnonymousAccess and ExternalAuthorization are both true, it indicates that the Anonymous version is supported as well.
      • SupportedRecognitionTypes - optional; [StringList]
        A list of recognition types that the device supports. This field is only relevant for devices that are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]). Please note that when an access point is updated, then any previously supported recognition types are replaced with the new list. Recognition types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in pt:RecognitionType. For custom defined identifier types, free text can be used.
      • IdentifierAccess - optional; [boolean]
        Indicates whether or not this access point supports the AccessControl/Request/Identifier event to request external authorization. Identfier access requires that ExternalAuthorization is set to true. The IdentifierAccess capability is typically enabled for devices that do not have any knowledge of credential tokens. When IdentifierAccess is set to true then the device must support the identifier events.
      • SupportedFeedbackTypes - optional; [StringList]
        List of supported feedback types. Feedback types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in tac:FeedbackType. For custom defined feedback types, free text can be used.
      • SupportedSecurityLevels - optional, unbounded; [ReferenceToken]
        A list of security level tokens that this access point supports. See [Authentication Behavior Service Specification]. This field is optional, and if omitted, the device cannot support multi-factor authentication for this access point. Please note that when an access point is updated, then any previously supported security levels are replaced with the new list.
        Minimum length: 0
        Maximum length: 64
      • Extension - optional; [SupportedSecurityLevelsExtension]
    • AuthenticationProfileToken - optional; [ReferenceToken]
      A reference to an authentication profile which defines the authentication behavior of the access point.
      Minimum length: 0
      Maximum length: 64
    • Extension - optional; [AccessPointExtension]

GetAccessPoints 

GetAccessPoints(Token)

This operation requests a list of AccessPoint items matching the given tokens.

The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.

Input
  • Token - unbounded; [ReferenceToken]
    Tokens of AccessPoint items to get.
    Minimum length: 0
    Maximum length: 64
Output
  • AccessPoint - optional, unbounded; [AccessPoint]
    List of AccessPoint items.
    • Capabilities [AccessPointCapabilities]
      The capabilities for the AccessPoint.
      • DisableAccessPoint - required; [boolean]
        Indicates whether or not this AccessPoint instance supports EnableAccessPoint and DisableAccessPoint commands.
      • Duress - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of duress events.
      • AnonymousAccess - optional; [boolean]
        Indicates whether or not this AccessPoint has a REX switch or other input that allows anonymous access.
      • AccessTaken - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of AccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it indicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported.
      • ExternalAuthorization - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports the ExternalAuthorization operation and the generation of Request events. If AnonymousAccess and ExternalAuthorization are both true, it indicates that the Anonymous version is supported as well.
      • SupportedRecognitionTypes - optional; [StringList]
        A list of recognition types that the device supports. This field is only relevant for devices that are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]). Please note that when an access point is updated, then any previously supported recognition types are replaced with the new list. Recognition types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in pt:RecognitionType. For custom defined identifier types, free text can be used.
      • IdentifierAccess - optional; [boolean]
        Indicates whether or not this access point supports the AccessControl/Request/Identifier event to request external authorization. Identfier access requires that ExternalAuthorization is set to true. The IdentifierAccess capability is typically enabled for devices that do not have any knowledge of credential tokens. When IdentifierAccess is set to true then the device must support the identifier events.
      • SupportedFeedbackTypes - optional; [StringList]
        List of supported feedback types. Feedback types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in tac:FeedbackType. For custom defined feedback types, free text can be used.
      • SupportedSecurityLevels - optional, unbounded; [ReferenceToken]
        A list of security level tokens that this access point supports. See [Authentication Behavior Service Specification]. This field is optional, and if omitted, the device cannot support multi-factor authentication for this access point. Please note that when an access point is updated, then any previously supported security levels are replaced with the new list.
        Minimum length: 0
        Maximum length: 64
      • Extension - optional; [SupportedSecurityLevelsExtension]
    • AuthenticationProfileToken - optional; [ReferenceToken]
      A reference to an authentication profile which defines the authentication behavior of the access point.
      Minimum length: 0
      Maximum length: 64
    • Extension - optional; [AccessPointExtension]

CreateAccessPoint 

CreateAccessPoint(AccessPoint)

This operation creates the specified access point in the device.

The token field of the AccessPoint structure shall be empty and the device shall allocate a token for the access point. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as a generic fault code.

Input
  • AccessPoint [AccessPoint]
    AccessPoint item to create
    • Capabilities [AccessPointCapabilities]
      The capabilities for the AccessPoint.
      • DisableAccessPoint - required; [boolean]
        Indicates whether or not this AccessPoint instance supports EnableAccessPoint and DisableAccessPoint commands.
      • Duress - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of duress events.
      • AnonymousAccess - optional; [boolean]
        Indicates whether or not this AccessPoint has a REX switch or other input that allows anonymous access.
      • AccessTaken - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of AccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it indicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported.
      • ExternalAuthorization - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports the ExternalAuthorization operation and the generation of Request events. If AnonymousAccess and ExternalAuthorization are both true, it indicates that the Anonymous version is supported as well.
      • SupportedRecognitionTypes - optional; [StringList]
        A list of recognition types that the device supports. This field is only relevant for devices that are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]). Please note that when an access point is updated, then any previously supported recognition types are replaced with the new list. Recognition types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in pt:RecognitionType. For custom defined identifier types, free text can be used.
      • IdentifierAccess - optional; [boolean]
        Indicates whether or not this access point supports the AccessControl/Request/Identifier event to request external authorization. Identfier access requires that ExternalAuthorization is set to true. The IdentifierAccess capability is typically enabled for devices that do not have any knowledge of credential tokens. When IdentifierAccess is set to true then the device must support the identifier events.
      • SupportedFeedbackTypes - optional; [StringList]
        List of supported feedback types. Feedback types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in tac:FeedbackType. For custom defined feedback types, free text can be used.
      • SupportedSecurityLevels - optional, unbounded; [ReferenceToken]
        A list of security level tokens that this access point supports. See [Authentication Behavior Service Specification]. This field is optional, and if omitted, the device cannot support multi-factor authentication for this access point. Please note that when an access point is updated, then any previously supported security levels are replaced with the new list.
        Minimum length: 0
        Maximum length: 64
      • Extension - optional; [SupportedSecurityLevelsExtension]
    • AuthenticationProfileToken - optional; [ReferenceToken]
      A reference to an authentication profile which defines the authentication behavior of the access point.
      Minimum length: 0
      Maximum length: 64
    • Extension - optional; [AccessPointExtension]
Output
  • Token [ReferenceToken]
    Token of created AccessPoint item
    Minimum length: 0
    Maximum length: 64

SetAccessPoint 

SetAccessPoint(AccessPoint)

This method is used to synchronize an access point in a client with the device.

If an access point with the specified token does not exist in the device, the access point is created. If an access point with the specified token exists, then the access point is modified. A call to this method takes an AccessPoint structure as input parameter. The token field of the AccessPoint structure shall not be empty. A device that signals support for the ClientSuppliedTokenSupported capability shall implement this command. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.

Input
  • AccessPoint [AccessPoint]
    AccessPoint item to create or modify
    • Capabilities [AccessPointCapabilities]
      The capabilities for the AccessPoint.
      • DisableAccessPoint - required; [boolean]
        Indicates whether or not this AccessPoint instance supports EnableAccessPoint and DisableAccessPoint commands.
      • Duress - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of duress events.
      • AnonymousAccess - optional; [boolean]
        Indicates whether or not this AccessPoint has a REX switch or other input that allows anonymous access.
      • AccessTaken - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of AccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it indicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported.
      • ExternalAuthorization - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports the ExternalAuthorization operation and the generation of Request events. If AnonymousAccess and ExternalAuthorization are both true, it indicates that the Anonymous version is supported as well.
      • SupportedRecognitionTypes - optional; [StringList]
        A list of recognition types that the device supports. This field is only relevant for devices that are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]). Please note that when an access point is updated, then any previously supported recognition types are replaced with the new list. Recognition types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in pt:RecognitionType. For custom defined identifier types, free text can be used.
      • IdentifierAccess - optional; [boolean]
        Indicates whether or not this access point supports the AccessControl/Request/Identifier event to request external authorization. Identfier access requires that ExternalAuthorization is set to true. The IdentifierAccess capability is typically enabled for devices that do not have any knowledge of credential tokens. When IdentifierAccess is set to true then the device must support the identifier events.
      • SupportedFeedbackTypes - optional; [StringList]
        List of supported feedback types. Feedback types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in tac:FeedbackType. For custom defined feedback types, free text can be used.
      • SupportedSecurityLevels - optional, unbounded; [ReferenceToken]
        A list of security level tokens that this access point supports. See [Authentication Behavior Service Specification]. This field is optional, and if omitted, the device cannot support multi-factor authentication for this access point. Please note that when an access point is updated, then any previously supported security levels are replaced with the new list.
        Minimum length: 0
        Maximum length: 64
      • Extension - optional; [SupportedSecurityLevelsExtension]
    • AuthenticationProfileToken - optional; [ReferenceToken]
      A reference to an authentication profile which defines the authentication behavior of the access point.
      Minimum length: 0
      Maximum length: 64
    • Extension - optional; [AccessPointExtension]

ModifyAccessPoint 

ModifyAccessPoint(AccessPoint)

This operation modifies the specified access point.

The token of the access point to modify is specified in the token field of the AccessPoint structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified access point. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.

Input
  • AccessPoint [AccessPoint]
    AccessPoint item to modify
    • Capabilities [AccessPointCapabilities]
      The capabilities for the AccessPoint.
      • DisableAccessPoint - required; [boolean]
        Indicates whether or not this AccessPoint instance supports EnableAccessPoint and DisableAccessPoint commands.
      • Duress - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of duress events.
      • AnonymousAccess - optional; [boolean]
        Indicates whether or not this AccessPoint has a REX switch or other input that allows anonymous access.
      • AccessTaken - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports generation of AccessTaken and AccessNotTaken events. If AnonymousAccess and AccessTaken are both true, it indicates that the Anonymous versions of AccessTaken and AccessNotTaken are supported.
      • ExternalAuthorization - optional; [boolean]
        Indicates whether or not this AccessPoint instance supports the ExternalAuthorization operation and the generation of Request events. If AnonymousAccess and ExternalAuthorization are both true, it indicates that the Anonymous version is supported as well.
      • SupportedRecognitionTypes - optional; [StringList]
        A list of recognition types that the device supports. This field is only relevant for devices that are not aware of security levels (see [ONVIF Authentication Behavior Service Specification]). Please note that when an access point is updated, then any previously supported recognition types are replaced with the new list. Recognition types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in pt:RecognitionType. For custom defined identifier types, free text can be used.
      • IdentifierAccess - optional; [boolean]
        Indicates whether or not this access point supports the AccessControl/Request/Identifier event to request external authorization. Identfier access requires that ExternalAuthorization is set to true. The IdentifierAccess capability is typically enabled for devices that do not have any knowledge of credential tokens. When IdentifierAccess is set to true then the device must support the identifier events.
      • SupportedFeedbackTypes - optional; [StringList]
        List of supported feedback types. Feedback types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in tac:FeedbackType. For custom defined feedback types, free text can be used.
      • SupportedSecurityLevels - optional, unbounded; [ReferenceToken]
        A list of security level tokens that this access point supports. See [Authentication Behavior Service Specification]. This field is optional, and if omitted, the device cannot support multi-factor authentication for this access point. Please note that when an access point is updated, then any previously supported security levels are replaced with the new list.
        Minimum length: 0
        Maximum length: 64
      • Extension - optional; [SupportedSecurityLevelsExtension]
    • AuthenticationProfileToken - optional; [ReferenceToken]
      A reference to an authentication profile which defines the authentication behavior of the access point.
      Minimum length: 0
      Maximum length: 64
    • Extension - optional; [AccessPointExtension]

DeleteAccessPoint 

DeleteAccessPoint(Token)

This operation deletes the specified access point.

If it is associated with one or more entities some devices may not be able to delete the access point, and consequently a ReferenceInUse fault shall be generated. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.

Input
  • Token [ReferenceToken]
    Token of AccessPoint item to delete.
    Minimum length: 0
    Maximum length: 64

SetAccessPointAuthenticationProfile 

SetAccessPointAuthenticationProfile(
    Token, AuthenticationProfileToken
)

This operation defines the authentication behavior for an access point.

Input
  • Token [ReferenceToken]
    Token of the AccessPoint.
    Minimum length: 0
    Maximum length: 64
  • AuthenticationProfileToken [ReferenceToken]
    Token of the AuthenticationProfile.
    Minimum length: 0
    Maximum length: 64

DeleteAccessPointAuthenticationProfile 

DeleteAccessPointAuthenticationProfile(Token)

This operation reverts the authentication behavior for an access point to its default behavior.

Input
  • Token [ReferenceToken]
    Token of the AccessPoint.
    Minimum length: 0
    Maximum length: 64

GetAreaInfoList 

GetAreaInfoList(Limit=None, StartReference=None)

This operation requests a list of all AreaInfo items provided by the device.

A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than the Limit parameter.

Input
  • Limit - optional; [int]
    Maximum number of entries to return. If not specified, less than one or higher than what the device supports, the number of items is determined by the device.
  • StartReference - optional; [string]
    Start returning entries from this start reference. If not specified, entries shall start from the beginning of the dataset.
Output
  • NextStartReference - optional; [string]
    StartReference to use in next call to get the following items. If absent, no more items to get.
  • AreaInfo - optional, unbounded; [AreaInfo]
    List of AreaInfo items.
    • Name [Name]
      User readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the Area. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024

GetAreaInfo 

GetAreaInfo(Token)

This operation requests a list of AreaInfo items matching the given tokens.

The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.

Input
  • Token - unbounded; [ReferenceToken]
    Tokens of AreaInfo items to get.
    Minimum length: 0
    Maximum length: 64
Output
  • AreaInfo - optional, unbounded; [AreaInfo]
    List of AreaInfo items.
    • Name [Name]
      User readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the Area. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024

GetAreaList 

GetAreaList(Limit=None, StartReference=None)

This operation requests a list of all Area items provided by the device.

A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than the Limit parameter.

Input
  • Limit - optional; [int]
    Maximum number of entries to return. If not specified, less than one or higher than what the device supports, the number of items is determined by the device.
  • StartReference - optional; [string]
    Start returning entries from this start reference. If not specified, entries shall start from the beginning of the dataset.
Output
  • NextStartReference - optional; [string]
    StartReference to use in next call to get the following items. If absent, no more items to get.
  • Area - optional, unbounded; [Area]
    List of Area items.
    • Extension - optional; [AreaExtension]

GetAreas 

GetAreas(Token)

This operation requests a list of Area items matching the given tokens.

The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.

Input
  • Token - unbounded; [ReferenceToken]
    Tokens of Area items to get.
    Minimum length: 0
    Maximum length: 64
Output
  • Area - optional, unbounded; [Area]
    List of Area items.
    • Extension - optional; [AreaExtension]

CreateArea 

CreateArea(Area)

This operation creates the specified area in the device.

The token field of the Area structure shall be empty and the device shall allocate a token for the area. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as a generic fault code.

Input
  • Area [Area]
    Area item to create
    • Extension - optional; [AreaExtension]
Output
  • Token [ReferenceToken]
    Token of created Area item
    Minimum length: 0
    Maximum length: 64

SetArea 

SetArea(Area)

This method is used to synchronize an area in a client with the device.

If an area with the specified token does not exist in the device, the area is created. If an area with the specified token exists, then the area is modified. A call to this method takes an Area structure as input parameter. The token field of the Area structure shall not be empty. A device that signals support for the ClientSuppliedTokenSupported capability shall implement this command. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.

Input
  • Area [Area]
    Area item to create or modify
    • Extension - optional; [AreaExtension]

ModifyArea 

ModifyArea(Area)

This operation modifies the specified area.

The token of the area to modify is specified in the token field of the Area structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified area. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.

Input
  • Area [Area]
    Area item to modify
    • Extension - optional; [AreaExtension]

DeleteArea 

DeleteArea(Token)

This operation deletes the specified area.

If it is associated with one or more entities some devices may not be able to delete the area, and consequently a ReferenceInUse fault shall be generated. If no token was specified in the request, the device shall return InvalidArgs as a generic fault code.

Input
  • Token [ReferenceToken]
    Token of Area item to delete.
    Minimum length: 0
    Maximum length: 64

GetAccessPointState 

GetAccessPointState(Token)

This operation requests the AccessPointState for the access point instance specified by the token.

Input
  • Token [ReferenceToken]
    Token of AccessPoint instance to get AccessPointState for.
    Minimum length: 0
    Maximum length: 64
Output
  • AccessPointState [AccessPointState]
    AccessPointState item.
    • Enabled [boolean]
      Indicates that the AccessPoint is enabled. By default this field value shall be True, if the DisableAccessPoint capabilities is not supported.

EnableAccessPoint 

EnableAccessPoint(Token)

This operation allows enabling an access point.

A device that signals support for DisableAccessPoint capability for a particular access point instance shall implement this command.

Input
  • Token [ReferenceToken]
    Token of the AccessPoint instance to enable.
    Minimum length: 0
    Maximum length: 64

DisableAccessPoint 

DisableAccessPoint(Token)

This operation allows disabling an access point.

A device that signals support for the DisableAccessPoint capability for a particular access point instance shall implement this command.

Input
  • Token [ReferenceToken]
    Token of the AccessPoint instance to disable.
    Minimum length: 0
    Maximum length: 64

Feedback 

Feedback(
    AccessPointToken,
    FeedbackType,
    RecognitionType=None,
    TextMessage=None,
)

This operation controls how the specified access point should indicate feedback.

A client can instruct the access point about the door status or that one or more identifiers are needed to grant access, etc. It is typically used in conjunction with the AccessControl/Request/Identifier event and the ExternalAuthorization operation to indicate progress and required recognition methods. The supported feedback types are indicated in the SupportedFeedbackTypes field in the access point capabilities. In cases where multiple combinations of recognition methods are possible, the RecognitionType field can contain multiple values. E.g. for the security level "Card+PIN or Card+Fingerprint", the feedback command for requesting the second recognition method would contain both pt:PIN and pt:Fingerprint in the RecognitionType field. If the device supports at least one feedback type the device shall implement this command.

Input
  • AccessPointToken [ReferenceToken]
    Token of the access point to control.
    Minimum length: 0
    Maximum length: 64
  • FeedbackType [string]
    The feedback type to use. Feedback types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in tac:FeedbackType. For custom defined feedback types, free text can be used. If feedback type is set to pt:RequireIdentifier, the RecognitionType field shall provide the required type(s). If the feedback type is not supported, it shall be ignored.
  • RecognitionType - optional, unbounded; [string]
    Optional list of recognition types requested by a client to get closer to making a decision. Used if FeedbackType is set to pt:RequireIdentifier. If a recognition type is not supported, it shall be ignored.
  • TextMessage - optional; [string]
    Optional textual feedback message. If not supported by the access point it shall be ignored.

ExternalAuthorization 

ExternalAuthorization(
    AccessPointToken,
    Decision,
    CredentialToken=None,
    Reason=None,
)

This operation allows to deny or grant decision at an access point instance.

A device that signals support for ExternalAuthorization capability for a particular access point instance shall implement this method.

Input
  • AccessPointToken [ReferenceToken]
    Token of the Access Point instance.
    Minimum length: 0
    Maximum length: 64
  • CredentialToken - optional; [ReferenceToken]
    Optional token of the Credential involved.
    Minimum length: 0
    Maximum length: 64
  • Reason - optional; [string]
    Optional reason for decision.
  • Decision [Decision]
    Decision - Granted or Denied.
    Enum Value Enum Description
    Granted The decision is to grant access.
    Denied The decision is to deny access.