Skip to content

Credential

Credential service implementation.

Credential

Bases: ONVIFService

0.0.1 2.6

Credential service client.

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

GetServiceCapabilities 

GetServiceCapabilities()

This operation returns the capabilities of the credential service.

Output
  • Capabilities [ServiceCapabilities]
    The capability response message contains the requested credential 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.
    • CredentialValiditySupported - required; [boolean]
      Indicates that the device supports credential validity.
    • CredentialAccessProfileValiditySupported - required; [boolean]
      Indicates that the device supports validity on the association between a credential and an access profile.
    • ValiditySupportsTimeValue - required; [boolean]
      Indicates that the device supports both date and time value for validity. If set to false, then the time value is ignored.
    • MaxCredentials - required; [unsignedInt]
      The maximum number of credential supported by the device. If set to 0, then operations using credential token are not supported.
    • MaxAccessProfilesPerCredential - required; [PositiveInteger]
      The maximum number of access profiles for a credential.
    • ResetAntipassbackSupported - required; [boolean]
      Indicates the device supports resetting of anti-passback violations and notifying on anti-passback violations.
    • ClientSuppliedTokenSupported - optional; [boolean]
      Indicates that the client is allowed to supply the token when creating credentials. To enable the use of the command SetCredential, the value must be set to true.
    • DefaultCredentialSuspensionDuration - optional; [duration]
      The default time period that the credential will temporary be suspended (e.g. by using the wrong PIN a predetermined number of times). The time period is defined as an [ISO 8601] duration string (e.g. "PT5M").
    • MaxWhitelistedItems - optional; [unsignedInt]
      The maximum number of whitelisted credential identifiers supported by the device.
    • MaxBlacklistedItems - optional; [unsignedInt]
      The maximum number of blacklisted credential identifiers supported by the device.
    • SupportedIdentifierType - unbounded; [Name]
      A list of identifier types that the device supports. Is of type text. Identifier types starting with the prefix pt: are reserved to define ONVIF-specific types as defined in pt:RecognitionType. Please note that pt:REX is not an identifier type. For custom defined identifier types, free text can be used.
      Minimum length: 0
      Maximum length: 64
    • Extension - optional; [ServiceCapabilitiesExtension]
      • SupportedExemptionType - optional, unbounded; [Name]
        A list of exemptions that the device supports. Supported exemptions starting with the prefix pt: are reserved to define ONVIF specific exemption types and these reserved exemption types shall all share "pt:<Name>" syntax.
        Minimum length: 0
        Maximum length: 64

GetSupportedFormatTypes 

GetSupportedFormatTypes(CredentialIdentifierTypeName)

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

Input
  • CredentialIdentifierTypeName [string]
    Name of the credential identifier type
Output
  • FormatTypeInfo - unbounded; [CredentialIdentifierFormatTypeInfo]
    Identifier format type
    • FormatType [string]
      A format type supported by the device. A list of supported format types is provided in [ISO 16484-5:2014-09 Annex P]. The BACnet type "CUSTOM" is not used in this specification. Instead device manufacturers can define their own format types.
    • Description [Description]
      User readable description of the credential identifier format type. It shall be up to 1024 characters. For custom types, it is recommended to describe how the octet string is encoded (following the structure in column Authentication Factor Value Encoding of [ISO 16484-5:2014-09 Annex P]).
      Minimum length: 0
      Maximum length: 1024
    • Extension - optional; [CredentialIdentifierFormatTypeInfoExtension]

GetCredentialInfo 

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.

Input
  • Token - unbounded; [ReferenceToken]
    Tokens of CredentialInfo items to get.
    Minimum length: 0
    Maximum length: 64
Output
  • CredentialInfo - optional, unbounded; [CredentialInfo]
    List of CredentialInfo items.
    • Description - optional; [Description]
      User readable description for the credential. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • CredentialHolderReference [simpleType]
      An external reference to a person holding this credential. The reference is a username or used ID in an external system, such as a directory service.
      Minimum length: 0
      Maximum length: 64
    • ValidFrom - optional; [dateTime]
      The start date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ValidTo - optional; [dateTime]
      The expiration date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).

GetCredentialInfoList 

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.

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.
  • CredentialInfo - optional, unbounded; [CredentialInfo]
    List of CredentialInfo items.
    • Description - optional; [Description]
      User readable description for the credential. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • CredentialHolderReference [simpleType]
      An external reference to a person holding this credential. The reference is a username or used ID in an external system, such as a directory service.
      Minimum length: 0
      Maximum length: 64
    • ValidFrom - optional; [dateTime]
      The start date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ValidTo - optional; [dateTime]
      The expiration date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).

GetCredentials 

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.

Input
  • Token - unbounded; [ReferenceToken]
    Token of Credentials to get
    Minimum length: 0
    Maximum length: 64
Output
  • Credential - optional, unbounded; [Credential]
    List of Credential items.
    • Description - optional; [Description]
      User readable description for the credential. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • CredentialHolderReference [simpleType]
      An external reference to a person holding this credential. The reference is a username or used ID in an external system, such as a directory service.
      Minimum length: 0
      Maximum length: 64
    • ValidFrom - optional; [dateTime]
      The start date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ValidTo - optional; [dateTime]
      The expiration date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • CredentialIdentifier - unbounded; [CredentialIdentifier]
      A list of credential identifier structures. At least one credential identifier is required. Maximum one credential identifier structure per type is allowed.
      • Type [CredentialIdentifierType]
        Contains the details of the credential identifier type. Is of type CredentialIdentifierType.
        • Name [Name]
          The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
          Minimum length: 0
          Maximum length: 64
        • FormatType [string]
          Specifies the format of the credential value for the specified identifier type name.
      • ExemptedFromAuthentication [boolean]
        If set to true, this credential identifier is not considered for authentication. For example if the access point requests Card plus PIN, and the credential identifier of type PIN is exempted from authentication, then the access point will not prompt for the PIN.
      • Value [hexBinary]
        The value of the identifier in hexadecimal representation.
    • CredentialAccessProfile - optional, unbounded; [CredentialAccessProfile]
      A list of credential access profile structures.
      • AccessProfileToken [ReferenceToken]
        The reference token of the associated access profile.
        Minimum length: 0
        Maximum length: 64
      • ValidFrom - optional; [dateTime]
        The start date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
      • ValidTo - optional; [dateTime]
        The end date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ExtendedGrantTime - optional; [boolean]
      A boolean indicating that the credential holder needs extra time to get through the door. ExtendedReleaseTime will be added to ReleaseTime, and ExtendedOpenTime will be added to OpenTime
      Default: false
    • Attribute - optional, unbounded; [Attribute]
      A list of credential attributes as name value pairs. Key names starting with the prefix pt: are reserved to define PACS specific attributes following the "pt:<Name>" syntax.
      • Name - required; [string]
        Name of attribute. Key names starting with "ONVIF" (any case) are reserved for ONVIF use.
      • Value - optional; [string]
        Value of attribute.
    • Extension - optional; [CredentialExtension]

GetCredentialList 

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.

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.
  • Credential - optional, unbounded; [Credential]
    List of Credential items.
    • Description - optional; [Description]
      User readable description for the credential. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • CredentialHolderReference [simpleType]
      An external reference to a person holding this credential. The reference is a username or used ID in an external system, such as a directory service.
      Minimum length: 0
      Maximum length: 64
    • ValidFrom - optional; [dateTime]
      The start date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ValidTo - optional; [dateTime]
      The expiration date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • CredentialIdentifier - unbounded; [CredentialIdentifier]
      A list of credential identifier structures. At least one credential identifier is required. Maximum one credential identifier structure per type is allowed.
      • Type [CredentialIdentifierType]
        Contains the details of the credential identifier type. Is of type CredentialIdentifierType.
        • Name [Name]
          The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
          Minimum length: 0
          Maximum length: 64
        • FormatType [string]
          Specifies the format of the credential value for the specified identifier type name.
      • ExemptedFromAuthentication [boolean]
        If set to true, this credential identifier is not considered for authentication. For example if the access point requests Card plus PIN, and the credential identifier of type PIN is exempted from authentication, then the access point will not prompt for the PIN.
      • Value [hexBinary]
        The value of the identifier in hexadecimal representation.
    • CredentialAccessProfile - optional, unbounded; [CredentialAccessProfile]
      A list of credential access profile structures.
      • AccessProfileToken [ReferenceToken]
        The reference token of the associated access profile.
        Minimum length: 0
        Maximum length: 64
      • ValidFrom - optional; [dateTime]
        The start date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
      • ValidTo - optional; [dateTime]
        The end date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ExtendedGrantTime - optional; [boolean]
      A boolean indicating that the credential holder needs extra time to get through the door. ExtendedReleaseTime will be added to ReleaseTime, and ExtendedOpenTime will be added to OpenTime
      Default: false
    • Attribute - optional, unbounded; [Attribute]
      A list of credential attributes as name value pairs. Key names starting with the prefix pt: are reserved to define PACS specific attributes following the "pt:<Name>" syntax.
      • Name - required; [string]
        Name of attribute. Key names starting with "ONVIF" (any case) are reserved for ONVIF use.
      • Value - optional; [string]
        Value of attribute.
    • Extension - optional; [CredentialExtension]

CreateCredential 

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.

Input
  • Credential [Credential]
    The credential to create.
    • Description - optional; [Description]
      User readable description for the credential. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • CredentialHolderReference [simpleType]
      An external reference to a person holding this credential. The reference is a username or used ID in an external system, such as a directory service.
      Minimum length: 0
      Maximum length: 64
    • ValidFrom - optional; [dateTime]
      The start date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ValidTo - optional; [dateTime]
      The expiration date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • CredentialIdentifier - unbounded; [CredentialIdentifier]
      A list of credential identifier structures. At least one credential identifier is required. Maximum one credential identifier structure per type is allowed.
      • Type [CredentialIdentifierType]
        Contains the details of the credential identifier type. Is of type CredentialIdentifierType.
        • Name [Name]
          The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
          Minimum length: 0
          Maximum length: 64
        • FormatType [string]
          Specifies the format of the credential value for the specified identifier type name.
      • ExemptedFromAuthentication [boolean]
        If set to true, this credential identifier is not considered for authentication. For example if the access point requests Card plus PIN, and the credential identifier of type PIN is exempted from authentication, then the access point will not prompt for the PIN.
      • Value [hexBinary]
        The value of the identifier in hexadecimal representation.
    • CredentialAccessProfile - optional, unbounded; [CredentialAccessProfile]
      A list of credential access profile structures.
      • AccessProfileToken [ReferenceToken]
        The reference token of the associated access profile.
        Minimum length: 0
        Maximum length: 64
      • ValidFrom - optional; [dateTime]
        The start date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
      • ValidTo - optional; [dateTime]
        The end date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ExtendedGrantTime - optional; [boolean]
      A boolean indicating that the credential holder needs extra time to get through the door. ExtendedReleaseTime will be added to ReleaseTime, and ExtendedOpenTime will be added to OpenTime
      Default: false
    • Attribute - optional, unbounded; [Attribute]
      A list of credential attributes as name value pairs. Key names starting with the prefix pt: are reserved to define PACS specific attributes following the "pt:<Name>" syntax.
      • Name - required; [string]
        Name of attribute. Key names starting with "ONVIF" (any case) are reserved for ONVIF use.
      • Value - optional; [string]
        Value of attribute.
    • Extension - optional; [CredentialExtension]
  • State [CredentialState]
    The state of the credential.
    • Enabled [boolean]
      True if the credential is enabled or false if the credential is disabled.
    • Reason - optional; [Name]
      Predefined ONVIF reasons as mentioned in the section 5.4.2.7 of credential service specification document. For any other reason, free text can be used.
      Minimum length: 0
      Maximum length: 64
    • AntipassbackState - optional; [AntipassbackState]
      A structure indicating the anti-passback state. This field shall be supported if the ResetAntipassbackSupported capability is set to true.
      • AntipassbackViolated [boolean]
        Indicates if anti-passback is violated for the credential.
    • Extension - optional; [CredentialStateExtension]
Output
  • Token [ReferenceToken]
    The token of the created credential
    Minimum length: 0
    Maximum length: 64

SetCredential 

SetCredential(CredentialData)

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

Input
  • CredentialData [CredentialData]
    Details of the credential.
    • Credential [Credential]
      A format type supported by the device. A list of supported format types is provided in [ISO 16484-5:2014-09 Annex P]. The BACnet type "CUSTOM" is not used in this specification. Instead device manufacturers can define their own format types.
      • Description - optional; [Description]
        User readable description for the credential. It shall be up to 1024 characters.
        Minimum length: 0
        Maximum length: 1024
      • CredentialHolderReference [simpleType]
        An external reference to a person holding this credential. The reference is a username or used ID in an external system, such as a directory service.
        Minimum length: 0
        Maximum length: 64
      • ValidFrom - optional; [dateTime]
        The start date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
      • ValidTo - optional; [dateTime]
        The expiration date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
      • CredentialIdentifier - unbounded; [CredentialIdentifier]
        A list of credential identifier structures. At least one credential identifier is required. Maximum one credential identifier structure per type is allowed.
        • Type [CredentialIdentifierType]
          Contains the details of the credential identifier type. Is of type CredentialIdentifierType.
          • Name [Name]
            The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
            Minimum length: 0
            Maximum length: 64
          • FormatType [string]
            Specifies the format of the credential value for the specified identifier type name.
        • ExemptedFromAuthentication [boolean]
          If set to true, this credential identifier is not considered for authentication. For example if the access point requests Card plus PIN, and the credential identifier of type PIN is exempted from authentication, then the access point will not prompt for the PIN.
        • Value [hexBinary]
          The value of the identifier in hexadecimal representation.
      • CredentialAccessProfile - optional, unbounded; [CredentialAccessProfile]
        A list of credential access profile structures.
        • AccessProfileToken [ReferenceToken]
          The reference token of the associated access profile.
          Minimum length: 0
          Maximum length: 64
        • ValidFrom - optional; [dateTime]
          The start date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
        • ValidTo - optional; [dateTime]
          The end date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
      • ExtendedGrantTime - optional; [boolean]
        A boolean indicating that the credential holder needs extra time to get through the door. ExtendedReleaseTime will be added to ReleaseTime, and ExtendedOpenTime will be added to OpenTime
        Default: false
      • Attribute - optional, unbounded; [Attribute]
        A list of credential attributes as name value pairs. Key names starting with the prefix pt: are reserved to define PACS specific attributes following the "pt:<Name>" syntax.
        • Name - required; [string]
          Name of attribute. Key names starting with "ONVIF" (any case) are reserved for ONVIF use.
        • Value - optional; [string]
          Value of attribute.
      • Extension - optional; [CredentialExtension]
    • CredentialState [CredentialState]
      User readable description of the credential identifier format type. It shall be up to 1024 characters. For custom types, it is recommended to describe how the octet string is encoded (following the structure in column Authentication Factor Value Encoding of [ISO 16484-5:2014-09 Annex P]).
      • Enabled [boolean]
        True if the credential is enabled or false if the credential is disabled.
      • Reason - optional; [Name]
        Predefined ONVIF reasons as mentioned in the section 5.4.2.7 of credential service specification document. For any other reason, free text can be used.
        Minimum length: 0
        Maximum length: 64
      • AntipassbackState - optional; [AntipassbackState]
        A structure indicating the anti-passback state. This field shall be supported if the ResetAntipassbackSupported capability is set to true.
        • AntipassbackViolated [boolean]
          Indicates if anti-passback is violated for the credential.
      • Extension - optional; [CredentialStateExtension]
    • Extension - optional; [CredentialDataExtension]

ModifyCredential 

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.

Input
  • Credential [Credential]
    Details of the credential.
    • Description - optional; [Description]
      User readable description for the credential. It shall be up to 1024 characters.
      Minimum length: 0
      Maximum length: 1024
    • CredentialHolderReference [simpleType]
      An external reference to a person holding this credential. The reference is a username or used ID in an external system, such as a directory service.
      Minimum length: 0
      Maximum length: 64
    • ValidFrom - optional; [dateTime]
      The start date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ValidTo - optional; [dateTime]
      The expiration date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • CredentialIdentifier - unbounded; [CredentialIdentifier]
      A list of credential identifier structures. At least one credential identifier is required. Maximum one credential identifier structure per type is allowed.
      • Type [CredentialIdentifierType]
        Contains the details of the credential identifier type. Is of type CredentialIdentifierType.
        • Name [Name]
          The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
          Minimum length: 0
          Maximum length: 64
        • FormatType [string]
          Specifies the format of the credential value for the specified identifier type name.
      • ExemptedFromAuthentication [boolean]
        If set to true, this credential identifier is not considered for authentication. For example if the access point requests Card plus PIN, and the credential identifier of type PIN is exempted from authentication, then the access point will not prompt for the PIN.
      • Value [hexBinary]
        The value of the identifier in hexadecimal representation.
    • CredentialAccessProfile - optional, unbounded; [CredentialAccessProfile]
      A list of credential access profile structures.
      • AccessProfileToken [ReferenceToken]
        The reference token of the associated access profile.
        Minimum length: 0
        Maximum length: 64
      • ValidFrom - optional; [dateTime]
        The start date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
      • ValidTo - optional; [dateTime]
        The end date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ExtendedGrantTime - optional; [boolean]
      A boolean indicating that the credential holder needs extra time to get through the door. ExtendedReleaseTime will be added to ReleaseTime, and ExtendedOpenTime will be added to OpenTime
      Default: false
    • Attribute - optional, unbounded; [Attribute]
      A list of credential attributes as name value pairs. Key names starting with the prefix pt: are reserved to define PACS specific attributes following the "pt:<Name>" syntax.
      • Name - required; [string]
        Name of attribute. Key names starting with "ONVIF" (any case) are reserved for ONVIF use.
      • Value - optional; [string]
        Value of attribute.
    • Extension - optional; [CredentialExtension]

DeleteCredential 

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.

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

GetCredentialState 

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.

Input
  • Token [ReferenceToken]
    Token of Credential
    Minimum length: 0
    Maximum length: 64
Output
  • State [CredentialState]
    State of the credential.
    • Enabled [boolean]
      True if the credential is enabled or false if the credential is disabled.
    • Reason - optional; [Name]
      Predefined ONVIF reasons as mentioned in the section 5.4.2.7 of credential service specification document. For any other reason, free text can be used.
      Minimum length: 0
      Maximum length: 64
    • AntipassbackState - optional; [AntipassbackState]
      A structure indicating the anti-passback state. This field shall be supported if the ResetAntipassbackSupported capability is set to true.
      • AntipassbackViolated [boolean]
        Indicates if anti-passback is violated for the credential.
    • Extension - optional; [CredentialStateExtension]

EnableCredential 

EnableCredential(Token, Reason=None)

This method is used to enable a credential.

Input
  • Token [ReferenceToken]
    The token of the credential
    Minimum length: 0
    Maximum length: 64
  • Reason - optional; [Name]
    Reason for enabling the credential.
    Minimum length: 0
    Maximum length: 64

DisableCredential 

DisableCredential(Token, Reason=None)

This method is used to disable a credential.

Input
  • Token [ReferenceToken]
    Token of the Credential
    Minimum length: 0
    Maximum length: 64
  • Reason - optional; [Name]
    Reason for disabling the credential
    Minimum length: 0
    Maximum length: 64

ResetAntipassbackViolation 

ResetAntipassbackViolation(CredentialToken)

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

Input
  • CredentialToken [ReferenceToken]
    Token of the Credential
    Minimum length: 0
    Maximum length: 64

GetCredentialIdentifiers 

GetCredentialIdentifiers(CredentialToken)

This method returns all the credential identifiers for a credential.

Input
  • CredentialToken [ReferenceToken]
    Token of the Credential
    Minimum length: 0
    Maximum length: 64
Output
  • CredentialIdentifier - optional, unbounded; [CredentialIdentifier]
    Identifier of the credential
    • Type [CredentialIdentifierType]
      Contains the details of the credential identifier type. Is of type CredentialIdentifierType.
      • Name [Name]
        The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
        Minimum length: 0
        Maximum length: 64
      • FormatType [string]
        Specifies the format of the credential value for the specified identifier type name.
    • ExemptedFromAuthentication [boolean]
      If set to true, this credential identifier is not considered for authentication. For example if the access point requests Card plus PIN, and the credential identifier of type PIN is exempted from authentication, then the access point will not prompt for the PIN.
    • Value [hexBinary]
      The value of the identifier in hexadecimal representation.

SetCredentialIdentifier 

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.

Input
  • CredentialToken [ReferenceToken]
    Token of the Credential
    Minimum length: 0
    Maximum length: 64
  • CredentialIdentifier [CredentialIdentifier]
    Identifier of the credential
    • Type [CredentialIdentifierType]
      Contains the details of the credential identifier type. Is of type CredentialIdentifierType.
      • Name [Name]
        The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
        Minimum length: 0
        Maximum length: 64
      • FormatType [string]
        Specifies the format of the credential value for the specified identifier type name.
    • ExemptedFromAuthentication [boolean]
      If set to true, this credential identifier is not considered for authentication. For example if the access point requests Card plus PIN, and the credential identifier of type PIN is exempted from authentication, then the access point will not prompt for the PIN.
    • Value [hexBinary]
      The value of the identifier in hexadecimal representation.

DeleteCredentialIdentifier 

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.

Input
  • CredentialToken [ReferenceToken]
    Token of the Credential
    Minimum length: 0
    Maximum length: 64
  • CredentialIdentifierTypeName [Name]
    Identifier type name of a credential
    Minimum length: 0
    Maximum length: 64

GetCredentialAccessProfiles 

GetCredentialAccessProfiles(CredentialToken)

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

Input
  • CredentialToken [ReferenceToken]
    Token of the Credential
    Minimum length: 0
    Maximum length: 64
Output
  • CredentialAccessProfile - optional, unbounded; [CredentialAccessProfile]
    Access Profiles of the credential
    • AccessProfileToken [ReferenceToken]
      The reference token of the associated access profile.
      Minimum length: 0
      Maximum length: 64
    • ValidFrom - optional; [dateTime]
      The start date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ValidTo - optional; [dateTime]
      The end date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).

SetCredentialAccessProfiles 

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.

Input
  • CredentialToken [ReferenceToken]
    Token of the Credential
    Minimum length: 0
    Maximum length: 64
  • CredentialAccessProfile - unbounded; [CredentialAccessProfile]
    Access Profiles of the credential
    • AccessProfileToken [ReferenceToken]
      The reference token of the associated access profile.
      Minimum length: 0
      Maximum length: 64
    • ValidFrom - optional; [dateTime]
      The start date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).
    • ValidTo - optional; [dateTime]
      The end date/time of the validity for the association between the credential and the access profile. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).

DeleteCredentialAccessProfiles 

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.

Input
  • CredentialToken [ReferenceToken]
    Token of the Credential
    Minimum length: 0
    Maximum length: 64
  • AccessProfileToken - unbounded; [ReferenceToken]
    Tokens of Access Profiles
    Minimum length: 0
    Maximum length: 64

GetWhitelist 

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.

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.
  • IdentifierType - optional; [string]
    Get only whitelisted credential identifiers with the specified identifier type.
  • FormatType - optional; [string]
    Get only whitelisted credential identifiers with the specified identifier format type.
  • Value - optional; [hexBinary]
    Get only whitelisted credential identifiers with the specified identifier value.
Output
  • NextStartReference - optional; [string]
    StartReference to use in next call to get the following items. If absent, no more items to get.
  • Identifier - optional, unbounded; [CredentialIdentifierItem]
    The whitelisted credential identifiers matching the request criteria.
    • Type [CredentialIdentifierType]
      Contains the details of the credential identifier type.
      • Name [Name]
        The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
        Minimum length: 0
        Maximum length: 64
      • FormatType [string]
        Specifies the format of the credential value for the specified identifier type name.
    • Value [hexBinary]
      The value of the identifier in hexadecimal representation.

AddToWhitelist 

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.

Input
  • Identifier - unbounded; [CredentialIdentifierItem]
    The credential identifiers to be added to the whitelist.
    • Type [CredentialIdentifierType]
      Contains the details of the credential identifier type.
      • Name [Name]
        The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
        Minimum length: 0
        Maximum length: 64
      • FormatType [string]
        Specifies the format of the credential value for the specified identifier type name.
    • Value [hexBinary]
      The value of the identifier in hexadecimal representation.

RemoveFromWhitelist 

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.

Input
  • Identifier - unbounded; [CredentialIdentifierItem]
    The credential identifiers to be removed from the whitelist.
    • Type [CredentialIdentifierType]
      Contains the details of the credential identifier type.
      • Name [Name]
        The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
        Minimum length: 0
        Maximum length: 64
      • FormatType [string]
        Specifies the format of the credential value for the specified identifier type name.
    • Value [hexBinary]
      The value of the identifier in hexadecimal representation.

DeleteWhitelist 

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 

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.

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.
  • IdentifierType - optional; [string]
    Get only blacklisted credential identifiers with the specified identifier type.
  • FormatType - optional; [string]
    Get only blacklisted credential identifiers with the specified identifier format type.
  • Value - optional; [hexBinary]
    Get only blacklisted credential identifiers with the specified identifier value.
Output
  • NextStartReference - optional; [string]
    StartReference to use in next call to get the following items. If absent, no more items to get.
  • Identifier - optional, unbounded; [CredentialIdentifierItem]
    The blacklisted credential identifiers matching the request criteria.
    • Type [CredentialIdentifierType]
      Contains the details of the credential identifier type.
      • Name [Name]
        The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
        Minimum length: 0
        Maximum length: 64
      • FormatType [string]
        Specifies the format of the credential value for the specified identifier type name.
    • Value [hexBinary]
      The value of the identifier in hexadecimal representation.

AddToBlacklist 

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.

Input
  • Identifier - unbounded; [CredentialIdentifierItem]
    The credential identifiers to be added to the blacklist.
    • Type [CredentialIdentifierType]
      Contains the details of the credential identifier type.
      • Name [Name]
        The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
        Minimum length: 0
        Maximum length: 64
      • FormatType [string]
        Specifies the format of the credential value for the specified identifier type name.
    • Value [hexBinary]
      The value of the identifier in hexadecimal representation.

RemoveFromBlacklist 

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.

Input
  • Identifier - unbounded; [CredentialIdentifierItem]
    The credential identifiers to be removed from the blacklist.
    • Type [CredentialIdentifierType]
      Contains the details of the credential identifier type.
      • Name [Name]
        The name of the credential identifier type, such as pt:Card, pt:PIN, etc.
        Minimum length: 0
        Maximum length: 64
      • FormatType [string]
        Specifies the format of the credential value for the specified identifier type name.
    • Value [hexBinary]
      The value of the identifier in hexadecimal representation.

DeleteBlacklist 

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.