Get-BWSIsEnrolled
NAME Get-BWSIsEnrolled SYNOPSIS Finds out whether a user is already enrolled for a specific trait. SYNTAX Get-BWSIsEnrolled [-BWS] <string> [-Certificate] <X509Certificate> [-BCID] <string> [-Trait <{Face | Periocular | Voice}>] [<CommonParameters>] DESCRIPTION Sometimes it is useful to know whether there is a template available for a specific user and trait before a client tries to perform a verification of this user using this trait. If no template is available, i.e. the user is not yet enrolled, the client could use another authentication mechanism and send the user to the enrollment procedure. 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) of the class for which to find out whether it is enrolled already or not. 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 -Trait <BioID.Trait> The biometric trait for which to look for a template belonging to the specified person. Face The face trait. Periocular The periocular (eye) trait. Voice The voice trait. Required? false Position? named Default value Face 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 if a template for the specified class and trait is available, i.e. a verification of the user is possible. Returns false when a template for the specified class and trait was not found, i.e. a verification of the user is not possible. In this case the user needs to enroll the specified trait before performing any biometric action on this trait. -------------------------- EXAMPLE -------------------------- $cert = get-childitem -path Cert:\CurrentUser\My\1234567890ABCDEF1234567890ABCDEF12345678 Get-BWSIsEnrolled -BWS bws.bioid.com/BioIDWebService.svc -Certificate $cert -BCID bws.123.12345 Detects whether the class bws.123.12345 is enrolled for the face trait.
RELATED LINKS
BWS IsEnrolled API
BioID Web Service reference