Invoke-BWSDeleteClass

NAME
    Invoke-BWSDeleteClass

SYNOPSIS
    Deletes a class from the storage of a BWS installation.


SYNTAX
    Invoke-BWSDeleteClass [-BWS] <string> [-Certificate] <X509Certificate> [-BCID] <string> [<CommonParameters>]


DESCRIPTION
    Deletes all data associated with the person specified by its biometric class id from the BWS storage. This
    deletion cannot be undone!


PARAMETERS
    -BWS <string>
        Specifies the BioID Web Service (BWS) installation where the command shall be executed. You can simply use the
        hostname like 'bws.bioid.com' or the entire URL, e.g. 'https://bws.bioid.com/BioIDWebService.svc'. If scheme
        and/or path are not given, the defaults (https, BioIDWebService.svc) are used.

        Required?                    true
        Position?                    1
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -Certificate <X509Certificate>
        Specifies the client certificate that is used to authenticate the BWS client. Enter a variable that contains a
        certificate or a command or expression that gets the certificate.

        To find a certificate, use Get-PfxCertificate or use the Get-ChildItem cmdlet in the Certificate (Cert:)
        drive. For example:
        get-childitem -path Cert:\CurrentUser\My\1234567890ABCDEF1234567890ABCDEF12345678

        If the certificate is not valid or does not have sufficient authority, the command fails.

        Required?                    true
        Position?                    2
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -BCID <string>
        The Biometric ClassID (BCID) identifies a class within the BWS. A class is an anonymous entity representing
        all the biometric data associated with a single individual.

        The BCID is a combination of a string, a partition id and the class id itself. The string specifies the
        Storage, e.g. the Windows Azure Storage Service to use, whereas the partition and class id is used within this
        storage to address the class.

        Required?                    true
        Position?                    3
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).


OUTPUTS
    bool
        Returns true when the specified class existed and has been deleted, false otherwise.


    -------------------------- EXAMPLE --------------------------

    $cert = get-childitem -path Cert:\CurrentUser\My\1234567890ABCDEF1234567890ABCDEF12345678
    Invoke-BWSDeleteClass -BWS bws.bioid.com/BioIDWebService.svc -Certificate $cert -BCID bws.123.12345

    Deletes any data associated with class bws.123.12345 from the storage of the default BWS multitenant instance.
RELATED LINKS
BWS Delete Class API
BioID Web Service reference