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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.