Credential

Credential service implementation.

`Credential`

Bases: ONVIFService

Credential service client.

Property	Details
First introduced	ONVIF Release 2.6 (June 2015)
Binding name	`CredentialBinding` (`ver10/credential/wsdl/credential.wsdl`)
Operations	credential.wsdl
Specification	Credential.xml

`GetServiceCapabilities()`

This operation returns the capabilities of the credential service.

`GetSupportedFormatTypes(CredentialIdentifierTypeName)`

This method returns all the supported format types of a specified identifier type that is supported by the device.

`GetCredentialInfo(Token)`

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

`GetCredentialInfoList(Limit=None, StartReference=None)`

This operation requests a list of all CredentialInfo 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 Access Control Service Specification] for more details. The number of items returned shall not be greater than the Limit parameter.

`GetCredentials(Token)`

This operation returns the specified credential 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 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.

`GetCredentialList(Limit=None, StartReference=None)`

This operation requests a list of all credential 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 section 4.8.3 in [Access Control Service Specification] for more details. The number of items returned shall not be greater the Limit parameter.

`CreateCredential(Credential, State)`

This operation creates a credential.

A call to this method takes a credential structure and a credential state structure as input parameters. The credential state can be created in disabled or enabled state. The token field of the credential shall be empty, the device shall allocate a token for the credential. 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 generic fault code.

`SetCredential(CredentialData)`

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

`ModifyCredential(Credential)`

This operation modifies the specified credential.

The token of the credential to modify is specified in the token field of the Credential structure and shall not be empty. All other fields in the structure shall overwrite the fields in the specified credential. When an existing credential is modified, the state is not modified explicitly. The only way for a client to change the state of a credential is to explicitly call the EnableCredential, DisableCredential or ResetAntipassback command. All existing credential identifiers and credential access profiles are removed and replaced with the specified entities.

`DeleteCredential(Token)`

This method deletes the specified credential.

If it is associated with one or more entities some devices may not be able to delete the credential, and consequently a ReferenceInUse fault shall be generated.

`GetCredentialState(Token)`

This method returns the state for the specified credential.

If the capability ResetAntipassbackSupported is set to true, then the device shall supply the anti-passback state in the returned credential state structure.

`EnableCredential(Token, Reason=None)`

This method is used to enable a credential.

`DisableCredential(Token, Reason=None)`

This method is used to disable a credential.

`ResetAntipassbackViolation(CredentialToken)`

This method is used to reset anti-passback violations for a specified credential.

`GetCredentialIdentifiers(CredentialToken)`

This method returns all the credential identifiers for a credential.

`SetCredentialIdentifier(CredentialToken, CredentialIdentifier)`

This operation creates or updates a credential identifier for a credential.

If the type of specified credential identifier already exists, the current credential identifier of that type is replaced. Otherwise the credential identifier is added.

`DeleteCredentialIdentifier(CredentialToken, CredentialIdentifierTypeName)`

This method deletes all the identifier values for the specified type.

However, if the identifier type name doesn’t exist in the device, it will be silently ignored without any response.

`GetCredentialAccessProfiles(CredentialToken)`

This method returns all the credential access profiles for a credential.

`SetCredentialAccessProfiles(CredentialToken, CredentialAccessProfile)`

This operation add or updates the credential access profiles for a credential.

The device shall update the credential access profile if the access profile token in the specified credential access profile matches. Otherwise the credential access profile is added.

`DeleteCredentialAccessProfiles(CredentialToken, AccessProfileToken)`

This method deletes all the credential access profiles for the specified tokens.

However, if no matching credential access profiles are found, the corresponding access profile tokens are silently ignored without any response.

`GetWhitelist(Limit=None, StartReference=None, IdentifierType=None, FormatType=None, Value=None)`

This command requests a list of all whitelisted credential identifiers in the device.

A device with capability MaxWhitelistedItems greater than zero, shall implement this command.

`AddToWhitelist(Identifier)`

This command adds the specified credential identifiers to the whitelist.

A device with capability MaxWhitelistedItems greater than zero, shall implement this command. If a specified whitelist item also is blacklisted, the item shall be removed from the blacklist.

`RemoveFromWhitelist(Identifier)`

This command removes the specified credential identifiers from the whitelist.

A device with capability MaxWhitelistedItems greater than zero, shall implement this command. This command is idempotent and is safe to repeat even if the specified whitelist items do not exist.

`DeleteWhitelist()`

This command deletes all credential identifiers from the whitelist.

A device with capability MaxWhitelistedItems greater than zero, shall implement this command. This command is idempotent and is safe to repeat even if the whitelist already is empty.

`GetBlacklist(Limit=None, StartReference=None, IdentifierType=None, FormatType=None, Value=None)`

This command requests a list of all blacklisted credential identifiers in the device.

A device with capability MaxBlacklistedItems greater than zero, shall implement this command.

`AddToBlacklist(Identifier)`

This command adds the specified credential identifiers to the blacklist.

A device with capability MaxBlacklistedItems greater than zero, shall implement this command. If a specified blacklist item also is whitelisted, the item shall be removed from the whitelist.

`RemoveFromBlacklist(Identifier)`

This command removes the specified credential identifiers from the blacklist.

A device with capability MaxBlacklistedItems greater than zero, shall implement this command. This command is idempotent and is safe to repeat even if the specified blacklist items do not exist.

`DeleteBlacklist()`

This command deletes all credential identifiers from the blacklist.

A device with capability MaxBlacklistedItems greater than zero, shall implement this command. This command is idempotent and is safe to repeat even if the blacklist already is empty.