onvif
    Preparing search index...

    Interface Credential

    Credential service

    Example: Page credentials, inspect state / identifiers, enable one:

    import { Onvif } from 'onvif';

    const onvif = new Onvif({ hostname: '192.168.1.13', username: 'admin', password: 'admin' });
    await onvif.connect();

    const caps = await onvif.credential.getServiceCapabilities();
    const list = await onvif.credential.getCredentialInfoList({ limit: 20 });
    const token = list.credentialInfo![0].token;
    const [cred] = await onvif.credential.getCredentials({ token: [token] });
    const state = await onvif.credential.getCredentialState({ token });
    console.log(caps, cred?.description, state.enabled);

    await onvif.credential.enableCredential({ token });
    // await onvif.credential.disableCredential({ token });
    interface Credential {
        onvif: Onvif;
        service: keyof OnvifServices;
        xmlns: string;
        addToBlacklist(options: AddToBlacklist): Promise<void>;
        addToWhitelist(options: AddToWhitelist): Promise<void>;
        createCredential(options: CreateCredential): Promise<string>;
        deleteBlacklist(): Promise<void>;
        deleteCredential(options: DeleteCredential): Promise<void>;
        deleteCredentialAccessProfiles(
            options: DeleteCredentialAccessProfiles,
        ): Promise<void>;
        deleteCredentialIdentifier(
            options: DeleteCredentialIdentifier,
        ): Promise<void>;
        deleteWhitelist(): Promise<void>;
        disableCredential(options: DisableCredential): Promise<void>;
        enableCredential(options: EnableCredential): Promise<void>;
        getBlacklist(options?: GetBlacklist): Promise<GetBlacklistResponse>;
        getCredentialAccessProfiles(
            options: GetCredentialAccessProfiles,
        ): Promise<CredentialAccessProfile[] | undefined>;
        getCredentialIdentifiers(
            options: GetCredentialIdentifiers,
        ): Promise<CredentialIdentifier[] | undefined>;
        getCredentialInfo(options: GetCredentialInfo): Promise<CredentialInfo[]>;
        getCredentialInfoList(
            options?: GetCredentialInfoList,
        ): Promise<GetCredentialInfoListResponse>;
        getCredentialList(
            options?: GetCredentialList,
        ): Promise<GetCredentialListResponse>;
        getCredentials(options: GetCredentials): Promise<Credential[]>;
        getCredentialState(options: GetCredentialState): Promise<CredentialState>;
        getServiceCapabilities(): Promise<Capabilities>;
        getSupportedFormatTypes(
            options: GetSupportedFormatTypes,
        ): Promise<CredentialIdentifierFormatTypeInfo[]>;
        getWhitelist(options?: GetWhitelist): Promise<GetWhitelistResponse>;
        modifyCredential(options: ModifyCredential): Promise<void>;
        removeFromBlacklist(options: RemoveFromBlacklist): Promise<void>;
        removeFromWhitelist(options: RemoveFromWhitelist): Promise<void>;
        request<T = any>(
            body: OnvifSoapBody,
            options?: LineraseOptions,
        ): Promise<T>;
        resetAntipassbackViolation(
            options: ResetAntipassbackViolation,
        ): Promise<void>;
        setCredential(options: SetCredential): Promise<void>;
        setCredentialAccessProfiles(
            options: SetCredentialAccessProfiles,
        ): Promise<void>;
        setCredentialIdentifier(options: SetCredentialIdentifier): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    onvif service xmlns
    addToBlacklist addToWhitelist createCredential deleteBlacklist deleteCredential deleteCredentialAccessProfiles deleteCredentialIdentifier deleteWhitelist disableCredential enableCredential getBlacklist getCredentialAccessProfiles getCredentialIdentifiers getCredentialInfo getCredentialInfoList getCredentialList getCredentials getCredentialState getServiceCapabilities getSupportedFormatTypes getWhitelist modifyCredential removeFromBlacklist removeFromWhitelist request resetAntipassbackViolation setCredential setCredentialAccessProfiles setCredentialIdentifier
    onvif: Onvif
    service: keyof OnvifServices
    xmlns: string

    • Deletes all blacklisted credential identifiers.

      Returns Promise<void>

    • Deletes all whitelisted credential identifiers.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods