onvif
    Preparing search index...

    Interface Credential

    A Credential is a physical/tangible object, a piece of knowledge, or a facet of a person's physical being, that enables an individual access to a given physical facility or computer-based information system. A credential holds one or more credential identifiers. To gain access one or more identifiers may be required.

    interface Credential {
        attribute?: Attribute[];
        credentialAccessProfile?: CredentialAccessProfile[];
        credentialHolderReference: unknown;
        credentialIdentifier: CredentialIdentifier[];
        description?: string;
        extendedGrantTime?: boolean;
        extension?: CredentialExtension;
        token: string;
        validFrom?: Date;
        validTo?: Date;
    }

    Hierarchy (View Summary)

    Index
    attribute? credentialAccessProfile? credentialHolderReference credentialIdentifier description? extendedGrantTime? extension? token validFrom? validTo?
    attribute?: 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.

    credentialAccessProfile?: CredentialAccessProfile[]

    A list of credential access profile structures.

    credentialHolderReference: unknown

    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.

    credentialIdentifier: CredentialIdentifier[]

    A list of credential identifier structures. At least one credential identifier is required. Maximum one credential identifier structure per type is allowed.

    description?: string

    User readable description for the credential. It shall be up to 1024 characters.

    extendedGrantTime?: 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

    extension?: CredentialExtension
    token: string

    A service-unique identifier of the item.

    validFrom?: Date

    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?: Date

    The expiration date/time validity of the credential. If the ValiditySupportsTimeValue capability is set to false, then only date is supported (time is ignored).

    Settings
    Member Visibility

    On This Page
    Properties