Skip to content

AuthenticationBehavior

AuthenticationBehavior service implementation.

AuthenticationBehavior

Bases: ONVIFService

0.0.1 18.06

AuthenticationBehavior service client.

Property Details
First introduced ONVIF 18.06 (June 2018)
Binding name AuthenticationBehaviorBinding (ver10/authenticationbehavior/wsdl/authenticationbehavior.wsdl)
Operations authenticationbehavior.wsdl
Spec AuthenticationBehavior

GetServiceCapabilities 

GetServiceCapabilities()

This operation returns the capabilities of the authentication behavior service.

Output
  • Capabilities [ServiceCapabilities]
    The capability response message contains the requested access rules service capabilities using a hierarchical XML capability structure.
    • MaxLimit - required; [PositiveInteger]
      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.
    • MaxAuthenticationProfiles - required; [PositiveInteger]
      Indicates the maximum number of authentication profiles the device supports. The device shall support at least one authentication profile.
    • MaxPoliciesPerAuthenticationProfile - required; [PositiveInteger]
      Indicates the maximum number of authentication policies per authentication profile supported by the device.
    • MaxSecurityLevels - required; [PositiveInteger]
      Indicates the maximum number of security levels the device supports. The device shall support at least one security level.
    • MaxRecognitionGroupsPerSecurityLevel - required; [PositiveInteger]
      Indicates the maximum number of recognition groups per security level supported by the device.
    • MaxRecognitionMethodsPerRecognitionGroup - required; [PositiveInteger]
      Indicates the maximum number of recognition methods per recognition group supported by the device.
    • ClientSuppliedTokenSupported - optional; [boolean]
      Indicates that the client is allowed to supply the token when creating authentication profiles and security levels. To enable the use of the commands SetAuthenticationProfile and SetSecurityLevel, the value must be set to true.
    • SupportedAuthenticationModes - optional; [StringList]
      A list of supported authentication modes (including custom modes). This field is optional, and when omitted, the client shall assume that the device supports "pt:SingleCredential" only.

GetAuthenticationProfileInfo 

GetAuthenticationProfileInfo(Token)

This operation requests a list of AuthenticationProfileInfo 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.

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

GetAuthenticationProfileInfoList 

GetAuthenticationProfileInfoList(
    Limit=None, StartReference=None
)

This operation requests a list of all of AuthenticationProfileInfo 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 Access Control Service Specification for more details. The number of items returned shall not be greater than 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.
  • AuthenticationProfileInfo - optional, unbounded; [AuthenticationProfileInfo]
    List of AuthenticationProfileInfo items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024

GetAuthenticationProfiles 

GetAuthenticationProfiles(Token)

This operation returns the specified AuthenticationProfile item matching the given tokens.

The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching specified tokens. The device shall not return a fault in this case.

Input
  • Token - unbounded; [ReferenceToken]
    Tokens of AuthenticationProfile items to get.
    Minimum length: 0
    Maximum length: 64
Output
  • AuthenticationProfile - optional, unbounded; [AuthenticationProfile]
    List of AuthenticationProfile items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • DefaultSecurityLevelToken [ReferenceToken]
      The default security level is used if none of the authentication policies has a schedule covering the time of access (or if no authentication policies are defined).
      Minimum length: 0
      Maximum length: 64
    • AuthenticationPolicy - optional, unbounded; [AuthenticationPolicy]
      Each authentication policy associates a security level with a schedule (during which the specified security level will be required at the access point).
      • ScheduleToken [ReferenceToken]
        Reference to the schedule used by the authentication policy.
        Minimum length: 0
        Maximum length: 64
      • SecurityLevelConstraint - unbounded; [SecurityLevelConstraint]
        A list of security level constraint structures defining the conditions for what security level to use. Minimum one security level constraint must be specified.
        • ActiveRegularSchedule [boolean]
          Corresponds to the Active field in the ScheduleState structure in [ONVIF Schedule Service Specification].
        • ActiveSpecialDaySchedule [boolean]
          Corresponds to the SpecialDay field in the ScheduleState structure in [ONVIF Schedule Service Specification]. This field will be ignored if the device do not support special days.
        • AuthenticationMode - optional; [Name]
          Defines the mode of authentication. Authentication modes starting with the prefix pt: are reserved to define ONVIF-specific authentication modes. For custom defined authentication modes, free text can be used. The following authentication modes are defined by ONVIF: pt:SingleCredential - Normal mode where only one credential holder is required to be granted access. pt:DualCredential - Two credential holders are required to be granted access
          Default: pt:SingleCredential
          Minimum length: 0
          Maximum length: 64
        • SecurityLevelToken [ReferenceToken]
          Reference to the security level used by the authentication policy.
          Minimum length: 0
          Maximum length: 64
        • Extension - optional; [SecurityLevelConstraintExtension]
      • Extension - optional; [AuthenticationPolicyExtension]
    • Extension - optional; [AuthenticationProfileExtension]

GetAuthenticationProfileList 

GetAuthenticationProfileList(
    Limit=None, StartReference=None
)

This operation requests a list of all of AuthenticationProfile 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 Access Control Service Specification for more details. The number of items returned shall not be greater 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.
  • AuthenticationProfile - optional, unbounded; [AuthenticationProfile]
    List of AuthenticationProfile items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • DefaultSecurityLevelToken [ReferenceToken]
      The default security level is used if none of the authentication policies has a schedule covering the time of access (or if no authentication policies are defined).
      Minimum length: 0
      Maximum length: 64
    • AuthenticationPolicy - optional, unbounded; [AuthenticationPolicy]
      Each authentication policy associates a security level with a schedule (during which the specified security level will be required at the access point).
      • ScheduleToken [ReferenceToken]
        Reference to the schedule used by the authentication policy.
        Minimum length: 0
        Maximum length: 64
      • SecurityLevelConstraint - unbounded; [SecurityLevelConstraint]
        A list of security level constraint structures defining the conditions for what security level to use. Minimum one security level constraint must be specified.
        • ActiveRegularSchedule [boolean]
          Corresponds to the Active field in the ScheduleState structure in [ONVIF Schedule Service Specification].
        • ActiveSpecialDaySchedule [boolean]
          Corresponds to the SpecialDay field in the ScheduleState structure in [ONVIF Schedule Service Specification]. This field will be ignored if the device do not support special days.
        • AuthenticationMode - optional; [Name]
          Defines the mode of authentication. Authentication modes starting with the prefix pt: are reserved to define ONVIF-specific authentication modes. For custom defined authentication modes, free text can be used. The following authentication modes are defined by ONVIF: pt:SingleCredential - Normal mode where only one credential holder is required to be granted access. pt:DualCredential - Two credential holders are required to be granted access
          Default: pt:SingleCredential
          Minimum length: 0
          Maximum length: 64
        • SecurityLevelToken [ReferenceToken]
          Reference to the security level used by the authentication policy.
          Minimum length: 0
          Maximum length: 64
        • Extension - optional; [SecurityLevelConstraintExtension]
      • Extension - optional; [AuthenticationPolicyExtension]
    • Extension - optional; [AuthenticationProfileExtension]

CreateAuthenticationProfile 

CreateAuthenticationProfile(AuthenticationProfile)

This operation creates the specified authentication profile in the device.

The token field of the AuthenticationProfile structure shall be empty and the device shall allocate a token for the authentication profile. 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
  • AuthenticationProfile [AuthenticationProfile]
    The AuthenticationProfile to create.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • DefaultSecurityLevelToken [ReferenceToken]
      The default security level is used if none of the authentication policies has a schedule covering the time of access (or if no authentication policies are defined).
      Minimum length: 0
      Maximum length: 64
    • AuthenticationPolicy - optional, unbounded; [AuthenticationPolicy]
      Each authentication policy associates a security level with a schedule (during which the specified security level will be required at the access point).
      • ScheduleToken [ReferenceToken]
        Reference to the schedule used by the authentication policy.
        Minimum length: 0
        Maximum length: 64
      • SecurityLevelConstraint - unbounded; [SecurityLevelConstraint]
        A list of security level constraint structures defining the conditions for what security level to use. Minimum one security level constraint must be specified.
        • ActiveRegularSchedule [boolean]
          Corresponds to the Active field in the ScheduleState structure in [ONVIF Schedule Service Specification].
        • ActiveSpecialDaySchedule [boolean]
          Corresponds to the SpecialDay field in the ScheduleState structure in [ONVIF Schedule Service Specification]. This field will be ignored if the device do not support special days.
        • AuthenticationMode - optional; [Name]
          Defines the mode of authentication. Authentication modes starting with the prefix pt: are reserved to define ONVIF-specific authentication modes. For custom defined authentication modes, free text can be used. The following authentication modes are defined by ONVIF: pt:SingleCredential - Normal mode where only one credential holder is required to be granted access. pt:DualCredential - Two credential holders are required to be granted access
          Default: pt:SingleCredential
          Minimum length: 0
          Maximum length: 64
        • SecurityLevelToken [ReferenceToken]
          Reference to the security level used by the authentication policy.
          Minimum length: 0
          Maximum length: 64
        • Extension - optional; [SecurityLevelConstraintExtension]
      • Extension - optional; [AuthenticationPolicyExtension]
    • Extension - optional; [AuthenticationProfileExtension]
Output
  • Token [ReferenceToken]
    The Token of created AuthenticationProfile.
    Minimum length: 0
    Maximum length: 64

SetAuthenticationProfile 

SetAuthenticationProfile(AuthenticationProfile)

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

If an authentication profile with the specified token does not exist in the device, the authentication profile is created. If an authentication profile with the specified token exists, then the authentication profile is modified. A call to this method takes an AuthenticationProfile structure as input parameter. The token field of the AuthenticationProfile shall not be empty. A device that signals support for the ClientSuppliedTokenSupported capability shall implement this command.

Input
  • AuthenticationProfile [AuthenticationProfile]
    The AuthenticationProfile to create or modify.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • DefaultSecurityLevelToken [ReferenceToken]
      The default security level is used if none of the authentication policies has a schedule covering the time of access (or if no authentication policies are defined).
      Minimum length: 0
      Maximum length: 64
    • AuthenticationPolicy - optional, unbounded; [AuthenticationPolicy]
      Each authentication policy associates a security level with a schedule (during which the specified security level will be required at the access point).
      • ScheduleToken [ReferenceToken]
        Reference to the schedule used by the authentication policy.
        Minimum length: 0
        Maximum length: 64
      • SecurityLevelConstraint - unbounded; [SecurityLevelConstraint]
        A list of security level constraint structures defining the conditions for what security level to use. Minimum one security level constraint must be specified.
        • ActiveRegularSchedule [boolean]
          Corresponds to the Active field in the ScheduleState structure in [ONVIF Schedule Service Specification].
        • ActiveSpecialDaySchedule [boolean]
          Corresponds to the SpecialDay field in the ScheduleState structure in [ONVIF Schedule Service Specification]. This field will be ignored if the device do not support special days.
        • AuthenticationMode - optional; [Name]
          Defines the mode of authentication. Authentication modes starting with the prefix pt: are reserved to define ONVIF-specific authentication modes. For custom defined authentication modes, free text can be used. The following authentication modes are defined by ONVIF: pt:SingleCredential - Normal mode where only one credential holder is required to be granted access. pt:DualCredential - Two credential holders are required to be granted access
          Default: pt:SingleCredential
          Minimum length: 0
          Maximum length: 64
        • SecurityLevelToken [ReferenceToken]
          Reference to the security level used by the authentication policy.
          Minimum length: 0
          Maximum length: 64
        • Extension - optional; [SecurityLevelConstraintExtension]
      • Extension - optional; [AuthenticationPolicyExtension]
    • Extension - optional; [AuthenticationProfileExtension]

ModifyAuthenticationProfile 

ModifyAuthenticationProfile(AuthenticationProfile)

This operation modifies the specified authentication profile.

The token of the authentication profile to modify is specified in the token field of the AuthenticationProfile structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified authentication profile.

Input
  • AuthenticationProfile [AuthenticationProfile]
    The AuthenticationProfile to modify.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • DefaultSecurityLevelToken [ReferenceToken]
      The default security level is used if none of the authentication policies has a schedule covering the time of access (or if no authentication policies are defined).
      Minimum length: 0
      Maximum length: 64
    • AuthenticationPolicy - optional, unbounded; [AuthenticationPolicy]
      Each authentication policy associates a security level with a schedule (during which the specified security level will be required at the access point).
      • ScheduleToken [ReferenceToken]
        Reference to the schedule used by the authentication policy.
        Minimum length: 0
        Maximum length: 64
      • SecurityLevelConstraint - unbounded; [SecurityLevelConstraint]
        A list of security level constraint structures defining the conditions for what security level to use. Minimum one security level constraint must be specified.
        • ActiveRegularSchedule [boolean]
          Corresponds to the Active field in the ScheduleState structure in [ONVIF Schedule Service Specification].
        • ActiveSpecialDaySchedule [boolean]
          Corresponds to the SpecialDay field in the ScheduleState structure in [ONVIF Schedule Service Specification]. This field will be ignored if the device do not support special days.
        • AuthenticationMode - optional; [Name]
          Defines the mode of authentication. Authentication modes starting with the prefix pt: are reserved to define ONVIF-specific authentication modes. For custom defined authentication modes, free text can be used. The following authentication modes are defined by ONVIF: pt:SingleCredential - Normal mode where only one credential holder is required to be granted access. pt:DualCredential - Two credential holders are required to be granted access
          Default: pt:SingleCredential
          Minimum length: 0
          Maximum length: 64
        • SecurityLevelToken [ReferenceToken]
          Reference to the security level used by the authentication policy.
          Minimum length: 0
          Maximum length: 64
        • Extension - optional; [SecurityLevelConstraintExtension]
      • Extension - optional; [AuthenticationPolicyExtension]
    • Extension - optional; [AuthenticationProfileExtension]

DeleteAuthenticationProfile 

DeleteAuthenticationProfile(Token)

This operation deletes the specified authentication profile.

If the authentication profile is deleted, all authentication policies associated with the authentication profile will also be deleted. If it is associated with one or more entities some devices may not be able to delete the authentication profile, and consequently a ReferenceInUse fault shall be generated.

Input
  • Token [ReferenceToken]
    The token of the AuthenticationProfile to delete.
    Minimum length: 0
    Maximum length: 64

GetSecurityLevelInfo 

GetSecurityLevelInfo(Token)

This operation requests a list of SecurityLevelInfo 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.

Input
  • Token - unbounded; [ReferenceToken]
    Tokens of SecurityLevelInfo items to get.
    Minimum length: 0
    Maximum length: 64
Output
  • SecurityLevelInfo - optional, unbounded; [SecurityLevelInfo]
    List of SecurityLevelInfo items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Priority [int]
      A higher number indicates that the security level is considered more secure than security levels with lower priorities. The priority is used when an authentication profile have overlapping schedules with different security levels. When an access point is accessed, the authentication policies are walked through in priority order (highest priority first). When a schedule is found covering the time of access, the associated security level is used and processing stops. Two security levels cannot have the same priority.
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024

GetSecurityLevelInfoList 

GetSecurityLevelInfoList(Limit=None, StartReference=None)

This operation requests a list of all of SecurityLevelInfo 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 Access Control Service Specification for more details. The number of items returned shall not be greater than 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.
  • SecurityLevelInfo - optional, unbounded; [SecurityLevelInfo]
    List of SecurityLevelInfo items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Priority [int]
      A higher number indicates that the security level is considered more secure than security levels with lower priorities. The priority is used when an authentication profile have overlapping schedules with different security levels. When an access point is accessed, the authentication policies are walked through in priority order (highest priority first). When a schedule is found covering the time of access, the associated security level is used and processing stops. Two security levels cannot have the same priority.
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024

GetSecurityLevels 

GetSecurityLevels(Token)

This operation returns the specified SecurityLevel item matching the given tokens.

The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching specified tokens. The device shall not return a fault in this case.

Input
  • Token - unbounded; [ReferenceToken]
    Tokens of SecurityLevel items to get.
    Minimum length: 0
    Maximum length: 64
Output
  • SecurityLevel - optional, unbounded; [SecurityLevel]
    List of SecurityLevel items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Priority [int]
      A higher number indicates that the security level is considered more secure than security levels with lower priorities. The priority is used when an authentication profile have overlapping schedules with different security levels. When an access point is accessed, the authentication policies are walked through in priority order (highest priority first). When a schedule is found covering the time of access, the associated security level is used and processing stops. Two security levels cannot have the same priority.
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • RecognitionGroup - optional, unbounded; [RecognitionGroup]
      The recognition groups are used to define a logical OR between the groups. Each recognition group consists of one or more recognition methods.
      • RecognitionMethod - optional, unbounded; [RecognitionMethod]
        A list of recognition methods to request for at the access point.
        • RecognitionType [string]
          The requested type of recognition. Is of type text. 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.
        • Order [int]
          The order value defines when this recognition method will be requested in relation to the other recognition methods in the same security level. A lower number indicates that the recognition method will be requested before recognition methods with a higher number.
        • Extension - optional; [RecognitionMethodExtension]
      • Extension - optional; [RecognitionGroupExtension]
    • Extension - optional; [SecurityLevelExtension]

GetSecurityLevelList 

GetSecurityLevelList(Limit=None, StartReference=None)

This operation requests a list of all of SecurityLevel 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 Access Control Service Specification for more details. The number of items returned shall not be greater 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.
  • SecurityLevel - optional, unbounded; [SecurityLevel]
    List of SecurityLevel items.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Priority [int]
      A higher number indicates that the security level is considered more secure than security levels with lower priorities. The priority is used when an authentication profile have overlapping schedules with different security levels. When an access point is accessed, the authentication policies are walked through in priority order (highest priority first). When a schedule is found covering the time of access, the associated security level is used and processing stops. Two security levels cannot have the same priority.
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • RecognitionGroup - optional, unbounded; [RecognitionGroup]
      The recognition groups are used to define a logical OR between the groups. Each recognition group consists of one or more recognition methods.
      • RecognitionMethod - optional, unbounded; [RecognitionMethod]
        A list of recognition methods to request for at the access point.
        • RecognitionType [string]
          The requested type of recognition. Is of type text. 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.
        • Order [int]
          The order value defines when this recognition method will be requested in relation to the other recognition methods in the same security level. A lower number indicates that the recognition method will be requested before recognition methods with a higher number.
        • Extension - optional; [RecognitionMethodExtension]
      • Extension - optional; [RecognitionGroupExtension]
    • Extension - optional; [SecurityLevelExtension]

CreateSecurityLevel 

CreateSecurityLevel(SecurityLevel)

This operation creates the specified security level in the device.

The token field of the SecurityLevel structure shall be empty and the device shall allocate a token for the security level. 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
  • SecurityLevel [SecurityLevel]
    The SecurityLevel to create.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Priority [int]
      A higher number indicates that the security level is considered more secure than security levels with lower priorities. The priority is used when an authentication profile have overlapping schedules with different security levels. When an access point is accessed, the authentication policies are walked through in priority order (highest priority first). When a schedule is found covering the time of access, the associated security level is used and processing stops. Two security levels cannot have the same priority.
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • RecognitionGroup - optional, unbounded; [RecognitionGroup]
      The recognition groups are used to define a logical OR between the groups. Each recognition group consists of one or more recognition methods.
      • RecognitionMethod - optional, unbounded; [RecognitionMethod]
        A list of recognition methods to request for at the access point.
        • RecognitionType [string]
          The requested type of recognition. Is of type text. 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.
        • Order [int]
          The order value defines when this recognition method will be requested in relation to the other recognition methods in the same security level. A lower number indicates that the recognition method will be requested before recognition methods with a higher number.
        • Extension - optional; [RecognitionMethodExtension]
      • Extension - optional; [RecognitionGroupExtension]
    • Extension - optional; [SecurityLevelExtension]
Output
  • Token [ReferenceToken]
    The Token of created SecurityLevel.
    Minimum length: 0
    Maximum length: 64

SetSecurityLevel 

SetSecurityLevel(SecurityLevel)

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

If an security level with the specified token does not exist in the device, the security level is created. If an security level with the specified token exists, then the security level is modified. A call to this method takes an SecurityLevel structure as input parameter. The token field of the SecurityLevel shall not be empty. A device that signals support for the ClientSuppliedTokenSupported capability shall implement this command.

Input
  • SecurityLevel [SecurityLevel]
    The SecurityLevel to create or modify.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Priority [int]
      A higher number indicates that the security level is considered more secure than security levels with lower priorities. The priority is used when an authentication profile have overlapping schedules with different security levels. When an access point is accessed, the authentication policies are walked through in priority order (highest priority first). When a schedule is found covering the time of access, the associated security level is used and processing stops. Two security levels cannot have the same priority.
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • RecognitionGroup - optional, unbounded; [RecognitionGroup]
      The recognition groups are used to define a logical OR between the groups. Each recognition group consists of one or more recognition methods.
      • RecognitionMethod - optional, unbounded; [RecognitionMethod]
        A list of recognition methods to request for at the access point.
        • RecognitionType [string]
          The requested type of recognition. Is of type text. 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.
        • Order [int]
          The order value defines when this recognition method will be requested in relation to the other recognition methods in the same security level. A lower number indicates that the recognition method will be requested before recognition methods with a higher number.
        • Extension - optional; [RecognitionMethodExtension]
      • Extension - optional; [RecognitionGroupExtension]
    • Extension - optional; [SecurityLevelExtension]

ModifySecurityLevel 

ModifySecurityLevel(SecurityLevel)

This operation modifies the specified security level.

The token of the security level to modify is specified in the token field of the SecurityLevel structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified security level.

Input
  • SecurityLevel [SecurityLevel]
    The SecurityLevel to modify.
    • Name [Name]
      A user readable name. It shall be up to 64 characters.
      Minimum length: 0
      Maximum length: 64
    • Priority [int]
      A higher number indicates that the security level is considered more secure than security levels with lower priorities. The priority is used when an authentication profile have overlapping schedules with different security levels. When an access point is accessed, the authentication policies are walked through in priority order (highest priority first). When a schedule is found covering the time of access, the associated security level is used and processing stops. Two security levels cannot have the same priority.
    • Description - optional; [Description]
      User readable description for the access profile. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • RecognitionGroup - optional, unbounded; [RecognitionGroup]
      The recognition groups are used to define a logical OR between the groups. Each recognition group consists of one or more recognition methods.
      • RecognitionMethod - optional, unbounded; [RecognitionMethod]
        A list of recognition methods to request for at the access point.
        • RecognitionType [string]
          The requested type of recognition. Is of type text. 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.
        • Order [int]
          The order value defines when this recognition method will be requested in relation to the other recognition methods in the same security level. A lower number indicates that the recognition method will be requested before recognition methods with a higher number.
        • Extension - optional; [RecognitionMethodExtension]
      • Extension - optional; [RecognitionGroupExtension]
    • Extension - optional; [SecurityLevelExtension]

DeleteSecurityLevel 

DeleteSecurityLevel(Token)

This operation deletes the specified security level.

If the security level is deleted, all authentication policies associated with the security level will also be deleted. If it is associated with one or more entities some devices may not be able to delete the security level, and consequently a ReferenceInUse fault shall be generated.

Input
  • Token [ReferenceToken]
    The token of the SecurityLevel to delete.
    Minimum length: 0
    Maximum length: 64