diff --git a/docs/function-documentation/Access/Add-VerkadaAccessGroup.md b/docs/function-documentation/Access/Add-VerkadaAccessGroup.md index 9156517..eb0961e 100644 --- a/docs/function-documentation/Access/Add-VerkadaAccessGroup.md +++ b/docs/function-documentation/Access/Add-VerkadaAccessGroup.md @@ -33,7 +33,7 @@ This will add the access group with the name "NewGroup". The token will be popu ### EXAMPLE 2 ``` -Add-VerkadaAccessGroup -name 'NewGroup' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Add-VerkadaAccessGroup -name 'NewGroup' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will add the access group with the name "NewGroup". The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Add-VerkadaAccessUserCard.md b/docs/function-documentation/Access/Add-VerkadaAccessUserCard.md index b613ba9..1270b14 100644 --- a/docs/function-documentation/Access/Add-VerkadaAccessUserCard.md +++ b/docs/function-documentation/Access/Add-VerkadaAccessUserCard.md @@ -50,7 +50,7 @@ This will add a badge in the HID format with facility code 111 and card number 5 ### EXAMPLE 2 ``` -Add-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -type 'HID' -facilityCode 111 -cardNumber 55555 -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Add-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -type 'HID' -facilityCode 111 -cardNumber 55555 -x_verkada_auth_api 'v2_sd78d9verkada-token' This will add an Access credential in the HID format with facility code 111 and card number 55555 to the user specified. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Add-VerkadaAccessUserLicensePlate.md b/docs/function-documentation/Access/Add-VerkadaAccessUserLicensePlate.md index d9a3ea5..c75b904 100644 --- a/docs/function-documentation/Access/Add-VerkadaAccessUserLicensePlate.md +++ b/docs/function-documentation/Access/Add-VerkadaAccessUserLicensePlate.md @@ -35,7 +35,7 @@ This will add the license plate ABC123 to the Access user with userId 801c9551-b ### EXAMPLE 2 ``` -Add-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -name 'Users License Plate' -active $true -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a' +Add-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -name 'Users License Plate' -active $true -x_verkada_auth_api 'v2_sd78d9verkada-token' This will add the license plate ABC123 to the Access user with externalId newUserUPN@contoso.com as a credential and mark it active. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Add-VerkadaAccessUserMfaCode.md b/docs/function-documentation/Access/Add-VerkadaAccessUserMfaCode.md index 8977648..016ee05 100644 --- a/docs/function-documentation/Access/Add-VerkadaAccessUserMfaCode.md +++ b/docs/function-documentation/Access/Add-VerkadaAccessUserMfaCode.md @@ -33,7 +33,7 @@ This adds the MFA code 9567 to the Access user's profile with userId 801c9551-b0 ### EXAMPLE 2 ``` -Add-VerkadaAccessUserMfaCode -mfaCode '9567' -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Add-VerkadaAccessUserMfaCode -mfaCode '9567' -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This adds the MFA code 9567 to the Access user's profile with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Disable-VerkadaAccessUserCard.md b/docs/function-documentation/Access/Disable-VerkadaAccessUserCard.md index 4a61e3e..06a6964 100644 --- a/docs/function-documentation/Access/Disable-VerkadaAccessUserCard.md +++ b/docs/function-documentation/Access/Disable-VerkadaAccessUserCard.md @@ -33,7 +33,7 @@ This will deactivate the credential with cardId 10110010000000000000001011 for t ### EXAMPLE 2 ``` -Disable-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '10110010000000000000001011' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Disable-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '10110010000000000000001011' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will deactivate the credential with cardId 10110010000000000000001011 for the Access user with externalId newUserUPN@contoso.com as a credential. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Disable-VerkadaAccessUserFaceUnlock.md b/docs/function-documentation/Access/Disable-VerkadaAccessUserFaceUnlock.md new file mode 100644 index 0000000..647cd46 --- /dev/null +++ b/docs/function-documentation/Access/Disable-VerkadaAccessUserFaceUnlock.md @@ -0,0 +1,166 @@ +--- +external help file: verkadaModule-help.xml +Module Name: verkadaModule +online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Disable-VerkadaAccessUserFaceUnlock.md +schema: 2.0.0 +--- + +# Disable-VerkadaAccessUserFaceUnlock + +## SYNOPSIS +Disabled Face Unlock using https://apidocs.verkada.com/reference/deletefaceunlockdisableexternaluserviewv2 or https://apidocs.verkada.com/reference/deletefaceunlockdisableuserviewv2. + +## SYNTAX + +### user_id (Default) +``` +Disable-VerkadaAccessUserFaceUnlock -userId [-x_verkada_auth_api ] [-region ] + [-version ] [-errorsToFile] [-ProgressAction ] [] +``` + +### external_id +``` +Disable-VerkadaAccessUserFaceUnlock -externalId [-x_verkada_auth_api ] [-region ] + [-version ] [-errorsToFile] [-ProgressAction ] [] +``` + +## DESCRIPTION +Disable face unlock for a user. +This will delete their face credential and disable the face unlock access method. +Any pending mobile enrollment invitations for this user will also be deleted. +The reqired token can be directly submitted as a parameter, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. + +## EXAMPLES + +### EXAMPLE 1 +``` +Disable-VerkadaAccessUserFaceUnlock -externalId 'newUserUPN@contoso.com' +This will disable Face Unlock for the user with externalId newUserUPN@contoso.com and will delete the existing face credential.. The token will be populated from the cache created by Connect-Verkada. +``` + +### EXAMPLE 2 +``` +Disable-VerkadaAccessUserFaceUnlock -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -x_verkada_auth_api 'v2_sd78d9verkada-token' +This will disable Face Unlock for the user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 and will delete the existing face credential. The token is submitted as a parameter in the call. +``` + +## PARAMETERS + +### -userId +The UUID of the user + +```yaml +Type: String +Parameter Sets: user_id +Aliases: user_id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -externalId +unique identifier managed externally provided by the consumer + +```yaml +Type: String +Parameter Sets: external_id +Aliases: external_id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -x_verkada_auth_api +The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $Global:verkadaConnection.x_verkada_auth_api +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -region +The region of the public API to be used + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Api +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -version +Version designation for which version of the function to use + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: V2 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -errorsToFile +Switch to write errors to file + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Disable-VerkadaAccessUserFaceUnlock.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Disable-VerkadaAccessUserFaceUnlock.md) + diff --git a/docs/function-documentation/Access/Disable-VerkadaAccessUserLicensePlate.md b/docs/function-documentation/Access/Disable-VerkadaAccessUserLicensePlate.md index f7d53e4..789986e 100644 --- a/docs/function-documentation/Access/Disable-VerkadaAccessUserLicensePlate.md +++ b/docs/function-documentation/Access/Disable-VerkadaAccessUserLicensePlate.md @@ -33,7 +33,7 @@ This will deactivate the license plate ABC123 for the Access user with userId 80 ### EXAMPLE 2 ``` -Disable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Disable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will deactivate the license plate ABC123 for the Access user with externalId newUserUPN@contoso.com as a credential. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Enable-VerkadaAccessUserCard.md b/docs/function-documentation/Access/Enable-VerkadaAccessUserCard.md index 1847d2c..f69b7ab 100644 --- a/docs/function-documentation/Access/Enable-VerkadaAccessUserCard.md +++ b/docs/function-documentation/Access/Enable-VerkadaAccessUserCard.md @@ -33,7 +33,7 @@ This will activate the credential with cardId 10110010000000000000001011 for the ### EXAMPLE 2 ``` -Enable-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '3f3b3e4d-1a67-4b88-a321-43c5e502991c' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Enable-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '3f3b3e4d-1a67-4b88-a321-43c5e502991c' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will activate the credential with cardId 10110010000000000000001011 for the Access user with externalId newUserUPN@contoso.com as a credential. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Enable-VerkadaAccessUserFaceUnlock.md b/docs/function-documentation/Access/Enable-VerkadaAccessUserFaceUnlock.md new file mode 100644 index 0000000..db9ab93 --- /dev/null +++ b/docs/function-documentation/Access/Enable-VerkadaAccessUserFaceUnlock.md @@ -0,0 +1,225 @@ +--- +external help file: verkadaModule-help.xml +Module Name: verkadaModule +online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Enable-VerkadaAccessUserFaceUnlock.md +schema: 2.0.0 +--- + +# Enable-VerkadaAccessUserFaceUnlock + +## SYNOPSIS +Enables face unlock for an Access user using https://apidocs.verkada.com/reference/postfaceunlockcopyuserphotoexternaluserviewv2, https://apidocs.verkada.com/reference/postfaceunlockuploadphotoexternaluserviewv2, https://apidocs.verkada.com/reference/postfaceunlockcopyuserphotouserviewv2, and https://apidocs.verkada.com/reference/postfaceunlockuploadphotouserviewv2 + +## SYNTAX + +### external_profilePhoto (Default) +``` +Enable-VerkadaAccessUserFaceUnlock -externalId [-overwrite ] [-x_verkada_auth_api ] + [-region ] [-version ] [-errorsToFile] [-ProgressAction ] + [] +``` + +### user_upload +``` +Enable-VerkadaAccessUserFaceUnlock -userId -imagePath [-overwrite ] + [-x_verkada_auth_api ] [-region ] [-version ] [-errorsToFile] + [-ProgressAction ] [] +``` + +### user_profilePhoto +``` +Enable-VerkadaAccessUserFaceUnlock -userId [-overwrite ] [-x_verkada_auth_api ] + [-region ] [-version ] [-errorsToFile] [-ProgressAction ] + [] +``` + +### external_upload +``` +Enable-VerkadaAccessUserFaceUnlock -externalId -imagePath [-overwrite ] + [-x_verkada_auth_api ] [-region ] [-version ] [-errorsToFile] + [-ProgressAction ] [] +``` + +## DESCRIPTION +Enable face unlock for a user by using their existing profile photo by uploading a new photo. +This will create a face credential from the user's profile photo or by providing a photo via uplaod. +If the user already has a face credential and overwrite is False, the request will fail. +The profile photo must meet quality requirements for face recognition. +The reqired token can be directly submitted as a parameter, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. + +## EXAMPLES + +### EXAMPLE 1 +``` +Enable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' +This will enable Face Unlock for the user with externalId newUserUPN@contoso.com using their existing AC profile photo. The token will be populated from the cache created by Connect-Verkada. +``` + +### EXAMPLE 2 +``` +Enable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -imagePath './myPicture.png' -overwrite $true -x_verkada_auth_api 'v2_sd78d9verkada-token' +This will enable Face Unlock for the user with externalId newUserUPN@contoso.com using the photo specified in the imagePath, ./myPicture.png, and will overwrite the existing face credential if it exists. The token is submitted as a parameter in the call. +``` + +### EXAMPLE 3 +``` +Enable-VerkadaAccessUserLicensePlate -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' +This will enable Face Unlock for the user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 using their existing AC profile photo. The token will be populated from the cache created by Connect-Verkada. +``` + +### EXAMPLE 4 +``` +Enable-VerkadaAccessUserLicensePlate -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -imagePath './801c9551-b04c-4293-84ad-b0a6aa0588b3.png' -overwrite $true -x_verkada_auth_api 'v2_sd78d9verkada-token' +This will enable Face Unlock for the user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 using the photo specified in the imagePath, ./801c9551-b04c-4293-84ad-b0a6aa0588b3.png, and will overwrite the existing face credential if it exists. The token is submitted as a parameter in the call. +``` + +## PARAMETERS + +### -userId +The UUID of the user + +```yaml +Type: String +Parameter Sets: user_upload, user_profilePhoto +Aliases: user_id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -externalId +unique identifier managed externally provided by the consumer + +```yaml +Type: String +Parameter Sets: external_profilePhoto, external_upload +Aliases: external_id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -imagePath +This is the path the image will be uploaded from + +```yaml +Type: String +Parameter Sets: user_upload, external_upload +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -overwrite +The flag that states whether to overwrite the existing profile photo + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -x_verkada_auth_api +The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $Global:verkadaConnection.x_verkada_auth_api +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -region +The region of the public API to be used + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Api +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -version +Version designation for which version of the function to use + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: V2 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -errorsToFile +Switch to write errors to file + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Enable-VerkadaAccessUserFaceUnlock.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Enable-VerkadaAccessUserFaceUnlock.md) + diff --git a/docs/function-documentation/Access/Enable-VerkadaAccessUserLicensePlate.md b/docs/function-documentation/Access/Enable-VerkadaAccessUserLicensePlate.md index aae1350..8995a9e 100644 --- a/docs/function-documentation/Access/Enable-VerkadaAccessUserLicensePlate.md +++ b/docs/function-documentation/Access/Enable-VerkadaAccessUserLicensePlate.md @@ -33,7 +33,7 @@ This will activate the license plate ABC123 for the Access user with userId 801c ### EXAMPLE 2 ``` -Enable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Enable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will activate the license plate ABC123 for the Access user with externalId newUserUPN@contoso.com as a credential. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Get-VerkadaAccessEvents.md b/docs/function-documentation/Access/Get-VerkadaAccessEvents.md index e4bd015..0278582 100644 --- a/docs/function-documentation/Access/Get-VerkadaAccessEvents.md +++ b/docs/function-documentation/Access/Get-VerkadaAccessEvents.md @@ -33,7 +33,7 @@ This will return all the access events from 1 hour in the past until present. T ### EXAMPLE 2 ``` -Get-VerkadaAccessEvents -start_time 'January 1, 2025 9:00:00AM' -end_time 'February 8, 2025 10:30:00PM' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Get-VerkadaAccessEvents -start_time 'January 1, 2025 9:00:00AM' -end_time 'February 8, 2025 10:30:00PM' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return all the access events from Jan 1 at 9am to Feb 8 at 10:30pm. The token is submitted as parameter in the call. ``` diff --git a/docs/function-documentation/Access/Get-VerkadaAccessGroup.md b/docs/function-documentation/Access/Get-VerkadaAccessGroup.md index fc31df7..a4b8d87 100644 --- a/docs/function-documentation/Access/Get-VerkadaAccessGroup.md +++ b/docs/function-documentation/Access/Get-VerkadaAccessGroup.md @@ -32,7 +32,7 @@ This will return the Access Group with userId "7858d17a-3f72-4506-8532-a4b6ba233 ### EXAMPLE 2 ``` -Get-VerkadaAccessGroup -groupId '7858d17a-3f72-4506-8532-a4b6ba233c5e' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Get-VerkadaAccessGroup -groupId '7858d17a-3f72-4506-8532-a4b6ba233c5e' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return the Access Group with userId "7858d17a-3f72-4506-8532-a4b6ba233c5e". The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Get-VerkadaAccessUser.md b/docs/function-documentation/Access/Get-VerkadaAccessUser.md index 2bbab5a..a797888 100644 --- a/docs/function-documentation/Access/Get-VerkadaAccessUser.md +++ b/docs/function-documentation/Access/Get-VerkadaAccessUser.md @@ -31,7 +31,7 @@ This will retrieve the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa058 ### EXAMPLE 2 ``` -Get-VerkadaAccessUser -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Get-VerkadaAccessUser -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will retrieve the Access user with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Get-VerkadaAccessUserProfilePicture.md b/docs/function-documentation/Access/Get-VerkadaAccessUserProfilePicture.md index df63da0..f7f08ed 100644 --- a/docs/function-documentation/Access/Get-VerkadaAccessUserProfilePicture.md +++ b/docs/function-documentation/Access/Get-VerkadaAccessUserProfilePicture.md @@ -32,7 +32,7 @@ This downloads the Access user's, with userId 801c9551-b04c-4293-84ad-b0a6aa0588 ### EXAMPLE 2 ``` -Export-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -outPath './MyProfilePics' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Export-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -outPath './MyProfilePics' -x_verkada_auth_api 'v2_sd78d9verkada-token' This downloads the Access user's, with externalId newUserUPN@contoso.com picture to ./MyProfilePics/newUserUPN.jpg. The token is submitted as parameter in the call. ``` diff --git a/docs/function-documentation/Access/Read-VerkadaAccessGroups.md b/docs/function-documentation/Access/Read-VerkadaAccessGroups.md index e7bd57d..3e6d098 100644 --- a/docs/function-documentation/Access/Read-VerkadaAccessGroups.md +++ b/docs/function-documentation/Access/Read-VerkadaAccessGroups.md @@ -32,7 +32,7 @@ This will return aa the Access Groups. The token will be populated from the cac ### EXAMPLE 2 ``` -Read-VerkadaAccessGroups -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Read-VerkadaAccessGroups -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return aa the Access Groups. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Read-VerkadaAccessUsers.md b/docs/function-documentation/Access/Read-VerkadaAccessUsers.md index f3aecb0..af1f5e5 100644 --- a/docs/function-documentation/Access/Read-VerkadaAccessUsers.md +++ b/docs/function-documentation/Access/Read-VerkadaAccessUsers.md @@ -45,7 +45,7 @@ This will return all the active access users in an organization. The token is s ### EXAMPLE 3 ``` -Read-VerkadaAccessUsers -version v1 -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Read-VerkadaAccessUsers -version v1 -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return all the active access users in an organization using the Command v1 public API endpoint. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Remove-VerkadaAccessGroup.md b/docs/function-documentation/Access/Remove-VerkadaAccessGroup.md index 3fdda27..46d8f3a 100644 --- a/docs/function-documentation/Access/Remove-VerkadaAccessGroup.md +++ b/docs/function-documentation/Access/Remove-VerkadaAccessGroup.md @@ -31,7 +31,7 @@ This will delete the Access group with the groupId 2d64e7de-fd95-48be-8b5c-7a23b ### EXAMPLE 2 ``` -Remove-VerkadaAccessGroup -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaAccessGroup -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will delete the Access group with the groupId 2d64e7de-fd95-48be-8b5c-7a23bde94f52. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Remove-VerkadaAccessUserBleUnlock.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserBleUnlock.md index bf861d7..034777d 100644 --- a/docs/function-documentation/Access/Remove-VerkadaAccessUserBleUnlock.md +++ b/docs/function-documentation/Access/Remove-VerkadaAccessUserBleUnlock.md @@ -33,7 +33,7 @@ This will deactivate the Access user's Bluetooth unlock ability with userId 801c ### EXAMPLE 2 ``` -Remove-VerkadaAccessUserBleUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaAccessUserBleUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will deactivate the Access user's Bluetooth unlock ability with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Remove-VerkadaAccessUserCard.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserCard.md index 97e12ef..4e0da05 100644 --- a/docs/function-documentation/Access/Remove-VerkadaAccessUserCard.md +++ b/docs/function-documentation/Access/Remove-VerkadaAccessUserCard.md @@ -32,7 +32,7 @@ This will delete the credential with cardId 10110010000000000000001011 for the A ### EXAMPLE 2 ``` -Remove-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '10110010000000000000001011' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '10110010000000000000001011' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will delete the credential with cardId 10110010000000000000001011 for the Access user with externalId newUserUPN@contoso.com as a credential. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Remove-VerkadaAccessUserEntryCode.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserEntryCode.md index 84ad4ee..b4da5f2 100644 --- a/docs/function-documentation/Access/Remove-VerkadaAccessUserEntryCode.md +++ b/docs/function-documentation/Access/Remove-VerkadaAccessUserEntryCode.md @@ -33,7 +33,7 @@ This will remove the Access user's entry code with userId 801c9551-b04c-4293-84a ### EXAMPLE 2 ``` -Remove-VerkadaAccessUserEntryCode -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaAccessUserEntryCode -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will remove the Access user's entry code with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Remove-VerkadaAccessUserFromGroup.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserFromGroup.md index 2f94dce..cdee526 100644 --- a/docs/function-documentation/Access/Remove-VerkadaAccessUserFromGroup.md +++ b/docs/function-documentation/Access/Remove-VerkadaAccessUserFromGroup.md @@ -33,7 +33,7 @@ This will remove the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b ### EXAMPLE 2 ``` -Remove-VerkadaAccessUserFromGroup -externalId 'newUserUPN@contoso.com' -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaAccessUserFromGroup -externalId 'newUserUPN@contoso.com' -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will remove the Access user with externalId newUserUPN@contoso.com from the group with groupId 2d64e7de-fd95-48be-8b5c-7a23bde94f52. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Remove-VerkadaAccessUserLicensePlate.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserLicensePlate.md index 28bd7bd..dc34d7e 100644 --- a/docs/function-documentation/Access/Remove-VerkadaAccessUserLicensePlate.md +++ b/docs/function-documentation/Access/Remove-VerkadaAccessUserLicensePlate.md @@ -32,7 +32,7 @@ This will remove license plate ABC123 as a credential from the Access user with ### EXAMPLE 2 ``` -Remove-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will remove license plate ABC123 as a credential from the Access user with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Remove-VerkadaAccessUserMfaCode.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserMfaCode.md index 74e0055..eb5928d 100644 --- a/docs/function-documentation/Access/Remove-VerkadaAccessUserMfaCode.md +++ b/docs/function-documentation/Access/Remove-VerkadaAccessUserMfaCode.md @@ -32,7 +32,7 @@ This deletes the MFA code 9567 from the Access user's profile with userId 801c95 ### EXAMPLE 2 ``` -Remove-VerkadaAccessUserMfaCode -mfaCode '9567' -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaAccessUserMfaCode -mfaCode '9567' -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This deletes the MFA code 9567 from the Access user's profile with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Remove-VerkadaAccessUserProfilePicture.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserProfilePicture.md index 6b07e6b..f855357 100644 --- a/docs/function-documentation/Access/Remove-VerkadaAccessUserProfilePicture.md +++ b/docs/function-documentation/Access/Remove-VerkadaAccessUserProfilePicture.md @@ -32,7 +32,7 @@ This removes the Access user's profile picture with userId 801c9551-b04c-4293-84 ### EXAMPLE 2 ``` -Remove-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This removes the Access user's profile picture with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Remove-VerkadaAccessUserRemoteUnlock.md b/docs/function-documentation/Access/Remove-VerkadaAccessUserRemoteUnlock.md index 59eba56..508cee5 100644 --- a/docs/function-documentation/Access/Remove-VerkadaAccessUserRemoteUnlock.md +++ b/docs/function-documentation/Access/Remove-VerkadaAccessUserRemoteUnlock.md @@ -32,7 +32,7 @@ This will deactivate the Access user's Remote unlock ability with userId 801c955 ### EXAMPLE 2 ``` -Remove-VerkadaAccessUserRemoteUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaAccessUserRemoteUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will deactivate the Access user's Remote unlock ability with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Send-VerkadaAccessPassInvite.md b/docs/function-documentation/Access/Send-VerkadaAccessPassInvite.md index fddffce..f0eb6da 100644 --- a/docs/function-documentation/Access/Send-VerkadaAccessPassInvite.md +++ b/docs/function-documentation/Access/Send-VerkadaAccessPassInvite.md @@ -38,7 +38,7 @@ This will send an email invite to an Access user with userId 801c9551-b04c-4293- ### EXAMPLE 3 ``` -Send-VerkadaAccessPassInvite -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Send-VerkadaAccessPassInvite -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will send an email invite to an Access user with -externalId 'newUserUPN@contoso.com'. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Send-VerkadaAccessUserFaceUnlockInvite.md b/docs/function-documentation/Access/Send-VerkadaAccessUserFaceUnlockInvite.md new file mode 100644 index 0000000..379ef89 --- /dev/null +++ b/docs/function-documentation/Access/Send-VerkadaAccessUserFaceUnlockInvite.md @@ -0,0 +1,205 @@ +--- +external help file: verkadaModule-help.xml +Module Name: verkadaModule +online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaAccessUserFaceUnlockInvite.md +schema: 2.0.0 +--- + +# Send-VerkadaAccessUserFaceUnlockInvite + +## SYNOPSIS +Sends an invite for an Access user to enrol their face to enable Face Unlock using https://apidocs.verkada.com/reference/postfaceunlockinviteexternaluserviewv2 or https://apidocs.verkada.com/reference/postfaceunlockinviteuserviewv2 + +## SYNTAX + +### user_id (Default) +``` +Send-VerkadaAccessUserFaceUnlockInvite -userId [-overwrite ] [-method ] + [-x_verkada_auth_api ] [-region ] [-version ] [-errorsToFile] + [-ProgressAction ] [] +``` + +### external_id +``` +Send-VerkadaAccessUserFaceUnlockInvite -externalId [-overwrite ] [-method ] + [-x_verkada_auth_api ] [-region ] [-version ] [-errorsToFile] + [-ProgressAction ] [] +``` + +## DESCRIPTION +Enable face unlock for a user by sending them an invitation to enroll their face via mobile device. +An email will be sent to the user with a link to complete the enrollment process. +If the user already has a face credential and overwrite is False, the request will fail. +When overwrite is True, the invitation is sent and the user can upload a new photo which will replace the existing credential. +The reqired token can be directly submitted as a parameter, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. + +## EXAMPLES + +### EXAMPLE 1 +``` +Send-VerkadaAccessUserFaceUnlockInvite -externalId 'newUserUPN@contoso.com' +This will send a Face Unlock invite to the user with externalId newUserUPN@contoso.com. The token will be populated from the cache created by Connect-Verkada. +``` + +### EXAMPLE 2 +``` +Send-VerkadaAccessUserFaceUnlockInvite -externalId 'newUserUPN@contoso.com' -overwrite $true -x_verkada_auth_api 'v2_sd78d9verkada-token' +This will send a Face Unlock invite to the user with externalId newUserUPN@contoso.com and will overwrite the existing face credential if it exists. The token is submitted as a parameter in the call. +``` + +### EXAMPLE 3 +``` +Send-VerkadaAccessUserFaceUnlockInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -method 'email' +This will send a Face Unlock invite to the user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 via email only, not the default sms and email. The token will be populated from the cache created by Connect-Verkada. +``` + +## PARAMETERS + +### -userId +The UUID of the user + +```yaml +Type: String +Parameter Sets: user_id +Aliases: user_id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -externalId +unique identifier managed externally provided by the consumer + +```yaml +Type: String +Parameter Sets: external_id +Aliases: external_id + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -overwrite +The flag that states whether to overwrite the existing profile photo + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -method +The method to send the invite + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: @('email','sms') +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -x_verkada_auth_api +The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: $Global:verkadaConnection.x_verkada_auth_api +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -region +The region of the public API to be used + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: Api +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -version +Version designation for which version of the function to use + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: V2 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -errorsToFile +Switch to write errors to file + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +## NOTES + +## RELATED LINKS + +[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaAccessUserFaceUnlockInvite.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaAccessUserFaceUnlockInvite.md) + diff --git a/docs/function-documentation/Access/Set-VerkadaAccessUserBleUnlock.md b/docs/function-documentation/Access/Set-VerkadaAccessUserBleUnlock.md index 96ac609..5e46ebd 100644 --- a/docs/function-documentation/Access/Set-VerkadaAccessUserBleUnlock.md +++ b/docs/function-documentation/Access/Set-VerkadaAccessUserBleUnlock.md @@ -39,7 +39,7 @@ This will activate the Access user's Bluetooth unlock ability with userId 801c95 ### EXAMPLE 3 ``` -Set-VerkadaAccessUserBleUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Set-VerkadaAccessUserBleUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will activate the Access user's Bluetooth unlock ability with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Set-VerkadaAccessUserEndDate.md b/docs/function-documentation/Access/Set-VerkadaAccessUserEndDate.md index 4454af8..c4f3f4c 100644 --- a/docs/function-documentation/Access/Set-VerkadaAccessUserEndDate.md +++ b/docs/function-documentation/Access/Set-VerkadaAccessUserEndDate.md @@ -35,7 +35,7 @@ This sets the Access user's access to end at 8am on Nov 28, 2025 with userId 801 ### EXAMPLE 2 ``` -Set-VerkadaAccessUserEndDate -externalId 'newUserUPN@contoso.com' -endDate (Get-Date) -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Set-VerkadaAccessUserEndDate -externalId 'newUserUPN@contoso.com' -endDate (Get-Date) -x_verkada_auth_api 'v2_sd78d9verkada-token' This sets the Access user's access to end immediately since you are specifiying the current date and time with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Set-VerkadaAccessUserEntryCode.md b/docs/function-documentation/Access/Set-VerkadaAccessUserEntryCode.md index c8fa724..3d88acb 100644 --- a/docs/function-documentation/Access/Set-VerkadaAccessUserEntryCode.md +++ b/docs/function-documentation/Access/Set-VerkadaAccessUserEntryCode.md @@ -33,7 +33,7 @@ This will set an entry code of 12345 to the user specified. The token will be p ### EXAMPLE 2 ``` -Set-VerkadaAccessUserEntryCode -externalId 'newUserUPN@contoso.com' -entryCode '12345' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Set-VerkadaAccessUserEntryCode -externalId 'newUserUPN@contoso.com' -entryCode '12345' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will set an entry code of 12345 to the user specified. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Set-VerkadaAccessUserGroup.md b/docs/function-documentation/Access/Set-VerkadaAccessUserGroup.md index b07ee30..ea123b1 100644 --- a/docs/function-documentation/Access/Set-VerkadaAccessUserGroup.md +++ b/docs/function-documentation/Access/Set-VerkadaAccessUserGroup.md @@ -47,7 +47,7 @@ This adds the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 to Ac ### EXAMPLE 3 ``` -Set-VerkadaAccessUserGroup -externalId 'newUserUPN@contoso.com' -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Set-VerkadaAccessUserGroup -externalId 'newUserUPN@contoso.com' -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'v2_sd78d9verkada-token' This adds the Access user uwith xternalId newUserUPN@contoso.com to Access group with groupId 2d64e7de-fd95-48be-8b5c-7a23bde94f52. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Set-VerkadaAccessUserProfilePicture.md b/docs/function-documentation/Access/Set-VerkadaAccessUserProfilePicture.md index 17c91cf..df864d8 100644 --- a/docs/function-documentation/Access/Set-VerkadaAccessUserProfilePicture.md +++ b/docs/function-documentation/Access/Set-VerkadaAccessUserProfilePicture.md @@ -33,7 +33,7 @@ This sets the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 to us ### EXAMPLE 2 ``` -Set-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -imagePath './myPicture.png' -overwrite $true -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Set-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -imagePath './myPicture.png' -overwrite $true -x_verkada_auth_api 'v2_sd78d9verkada-token' This sets the Access user with externalId newUserUPN@contoso.com to use the picture specified at path ./myPicture.png and will overwrite the existing photo. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Set-VerkadaAccessUserRemoteUnlock.md b/docs/function-documentation/Access/Set-VerkadaAccessUserRemoteUnlock.md index 286288d..01aff59 100644 --- a/docs/function-documentation/Access/Set-VerkadaAccessUserRemoteUnlock.md +++ b/docs/function-documentation/Access/Set-VerkadaAccessUserRemoteUnlock.md @@ -32,7 +32,7 @@ This will activate the Access user's Remote unlock ability with userId 801c9551- ### EXAMPLE 2 ``` -Set-VerkadaAccessUserRemoteUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Set-VerkadaAccessUserRemoteUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will activate the Access user's Remote unlock ability with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Access/Set-VerkadaAccessUserStartDate.md b/docs/function-documentation/Access/Set-VerkadaAccessUserStartDate.md index 7ca165b..7cfdffc 100644 --- a/docs/function-documentation/Access/Set-VerkadaAccessUserStartDate.md +++ b/docs/function-documentation/Access/Set-VerkadaAccessUserStartDate.md @@ -35,7 +35,7 @@ This sets the Access user's access to start at 8am on Jan 28, 2022 with userId 8 ### EXAMPLE 2 ``` -Set-VerkadaAccessUserStartDate -externalId 'newUserUPN@contoso.com' -startDate (Get-Date) -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Set-VerkadaAccessUserStartDate -externalId 'newUserUPN@contoso.com' -startDate (Get-Date) -x_verkada_auth_api 'v2_sd78d9verkada-token' This sets the Access user's access to start immediately since you are specifiying the current date and time with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Cameras/Add-VerkadaCameraLicensePlateOfInterest.md b/docs/function-documentation/Cameras/Add-VerkadaCameraLicensePlateOfInterest.md index c4a7e69..f36f3fe 100644 --- a/docs/function-documentation/Cameras/Add-VerkadaCameraLicensePlateOfInterest.md +++ b/docs/function-documentation/Cameras/Add-VerkadaCameraLicensePlateOfInterest.md @@ -44,7 +44,7 @@ The token will be populated from the cache created by Connect-Verkada. ### EXAMPLE 4 ``` -Add-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Add-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate' -x_verkada_auth_api 'v2_sd78d9verkada-token' The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Cameras/Get-VerkadaCameraCloudBackupSettings.md b/docs/function-documentation/Cameras/Get-VerkadaCameraCloudBackupSettings.md index 5386e6e..03e5300 100644 --- a/docs/function-documentation/Cameras/Get-VerkadaCameraCloudBackupSettings.md +++ b/docs/function-documentation/Cameras/Get-VerkadaCameraCloudBackupSettings.md @@ -31,7 +31,7 @@ This will get the cloud backup settings of camera cwdfwfw-3f3-cwdf2-cameraId. T ### EXAMPLE 2 ``` -Get-VerkadaCameraCloudBackupSettings -camera_id "cwdfwfw-3f3-cwdf2-cameraId" -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Get-VerkadaCameraCloudBackupSettings -camera_id "cwdfwfw-3f3-cwdf2-cameraId" -x_verkada_auth_api 'v2_sd78d9verkada-token' This will get the cloud backup settings of camera cwdfwfw-3f3-cwdf2-cameraId. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Cameras/Get-VerkadaCameras.md b/docs/function-documentation/Cameras/Get-VerkadaCameras.md index a6b5f2d..baaa2f9 100644 --- a/docs/function-documentation/Cameras/Get-VerkadaCameras.md +++ b/docs/function-documentation/Cameras/Get-VerkadaCameras.md @@ -32,7 +32,7 @@ This will return all the cameras in the org. The token will be populated from t ### EXAMPLE 2 ``` -Get-VerkadaCameras -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Get-VerkadaCameras -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return all the cameras in the org. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Cameras/Get-VerkadaLicensePlatesOfInterest.md b/docs/function-documentation/Cameras/Get-VerkadaLicensePlatesOfInterest.md index 7c05cd7..402f5ec 100644 --- a/docs/function-documentation/Cameras/Get-VerkadaLicensePlatesOfInterest.md +++ b/docs/function-documentation/Cameras/Get-VerkadaLicensePlatesOfInterest.md @@ -37,7 +37,7 @@ The token will be populated from the cache created by Connect-Verkada. ### EXAMPLE 3 ``` -Get-VerkadaLicensePlatesOfInterest -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Get-VerkadaLicensePlatesOfInterest -x_verkada_auth_api 'v2_sd78d9verkada-token' The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.md b/docs/function-documentation/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.md index 0653775..8ab8238 100644 --- a/docs/function-documentation/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.md +++ b/docs/function-documentation/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.md @@ -43,7 +43,7 @@ The token will be populated from the cache created by Connect-Verkada. ### EXAMPLE 4 ``` -Remove-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -x_verkada_auth_api 'v2_sd78d9verkada-token' The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Cameras/Set-VerkadaCameraCloudBackupSettings.md b/docs/function-documentation/Cameras/Set-VerkadaCameraCloudBackupSettings.md index 3c4e417..866faba 100644 --- a/docs/function-documentation/Cameras/Set-VerkadaCameraCloudBackupSettings.md +++ b/docs/function-documentation/Cameras/Set-VerkadaCameraCloudBackupSettings.md @@ -33,7 +33,7 @@ This will set the camera cwdfwfw-3f3-cwdf2-cameraId to use cloud backup with the ### EXAMPLE 2 ``` -Set-VerkadaCameraCloudBackupSettings -enabled 1 -upload_timeslot '0,86400' -time_to_preserve '25200,68400' -days_to_preserve '1,1,1,1,1,1,1' -video_to_upload 'ALL' -video_quality 'STANDARD_QUALITY' -camera_id 'cwdfwfw-3f3-cwdf2-cameraId' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Set-VerkadaCameraCloudBackupSettings -enabled 1 -upload_timeslot '0,86400' -time_to_preserve '25200,68400' -days_to_preserve '1,1,1,1,1,1,1' -video_to_upload 'ALL' -video_quality 'STANDARD_QUALITY' -camera_id 'cwdfwfw-3f3-cwdf2-cameraId' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will set the camera cwdfwfw-3f3-cwdf2-cameraId to use cloud backup with the submitted settings. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Cameras/Set-VerkadaCameraLicensePlateOfInterest.md b/docs/function-documentation/Cameras/Set-VerkadaCameraLicensePlateOfInterest.md index 1403864..9219488 100644 --- a/docs/function-documentation/Cameras/Set-VerkadaCameraLicensePlateOfInterest.md +++ b/docs/function-documentation/Cameras/Set-VerkadaCameraLicensePlateOfInterest.md @@ -44,7 +44,7 @@ The token will be populated from the cache created by Connect-Verkada. ### EXAMPLE 4 ``` -Set-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate Descriptionv2' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Set-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate Descriptionv2' -x_verkada_auth_api 'v2_sd78d9verkada-token' The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Common/Connect-Verkada.md b/docs/function-documentation/Common/Connect-Verkada.md index 31db14f..ae50428 100644 --- a/docs/function-documentation/Common/Connect-Verkada.md +++ b/docs/function-documentation/Common/Connect-Verkada.md @@ -61,7 +61,7 @@ This will authenticate user admin.user@contoso.com with a otp token and a secure ### EXAMPLE 5 ``` -Connect-Verkada -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'myapiKey-dcwdskjnlnlkj' -userName "admin.user@contoso.com" -Password +Connect-Verkada -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_api_key 'myapiKey-dcwdskjnlnlkj' -userName "admin.user@contoso.com" -Password This will store the org_id 7cd47706-f51b-4419-8675-3b9f0ce7c12d with the public API key myapiKey-dcwdskjnlnlkj and will authenticate user admin.user@contoso.com by prompting for the password(stored as a secure string) and storing the returned tokens. This will no longer work for OrgAdmins due to the MFA requirement. ``` diff --git a/docs/function-documentation/Core/Add-VerkadaCommandUser.md b/docs/function-documentation/Core/Add-VerkadaCommandUser.md index bb741e6..0b37d89 100644 --- a/docs/function-documentation/Core/Add-VerkadaCommandUser.md +++ b/docs/function-documentation/Core/Add-VerkadaCommandUser.md @@ -36,7 +36,7 @@ This will add the Command user with the name "New User". The token will be popu ### EXAMPLE 2 ``` -Add-VerkadaCommandUser -firstName 'New' -lastName 'User' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Add-VerkadaCommandUser -firstName 'New' -lastName 'User' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will add the Command user with the name "New User". The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Core/Get-VerkadaCommandUser.md b/docs/function-documentation/Core/Get-VerkadaCommandUser.md index cc8f5ed..00e8d59 100644 --- a/docs/function-documentation/Core/Get-VerkadaCommandUser.md +++ b/docs/function-documentation/Core/Get-VerkadaCommandUser.md @@ -31,7 +31,7 @@ This will attempt to get the user details of a user with the userId of '3651fbcb ### EXAMPLE 2 ``` -Get-VerkadaCommandUser -externalId 'UserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Get-VerkadaCommandUser -externalId 'UserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will attempt to get the user details of a user with the externalId UserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Core/Remove-VerkadaCommandUser.md b/docs/function-documentation/Core/Remove-VerkadaCommandUser.md index 89dcd26..1b2078c 100644 --- a/docs/function-documentation/Core/Remove-VerkadaCommandUser.md +++ b/docs/function-documentation/Core/Remove-VerkadaCommandUser.md @@ -31,7 +31,7 @@ This will delete the Command user with userId 801c9551-b04c-4293-84ad-b0a6aa0588 ### EXAMPLE 2 ``` -Remove-VerkadaCommandUser -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaCommandUser -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will delete the Command user with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Core/Set-VerkadaCommandUser.md b/docs/function-documentation/Core/Set-VerkadaCommandUser.md index 101ae30..91f37bc 100644 --- a/docs/function-documentation/Core/Set-VerkadaCommandUser.md +++ b/docs/function-documentation/Core/Set-VerkadaCommandUser.md @@ -34,7 +34,7 @@ This will update the Command user with userId 801c9551-b04c-4293-84ad-b0a6aa0588 ### EXAMPLE 2 ``` -Set-VerkadaCommandUser -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -firstName 'New' -lastName 'User' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Set-VerkadaCommandUser -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -firstName 'New' -lastName 'User' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will update the Command user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 with the name "New User". The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Guest/Read-VerkadaGuestSites.md b/docs/function-documentation/Guest/Read-VerkadaGuestSites.md index 6111f09..1579e28 100644 --- a/docs/function-documentation/Guest/Read-VerkadaGuestSites.md +++ b/docs/function-documentation/Guest/Read-VerkadaGuestSites.md @@ -31,7 +31,7 @@ This will return all the Guest in an organization. The token will be populated ### EXAMPLE 2 ``` -Read-VerkadaGuestSites -userId 'aefrfefb-3429-39ec-b042-userAC' -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a' -x_verkada_auth 'auth-token-uuid-dscsdc' -usr 'a099bfe6-34ff-4976-9d53-ac68342d2b60' +Read-VerkadaGuestSites -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return all the Guest sites in an organization. The token will be populated from the cache created by Connect-Verkada. ``` diff --git a/docs/function-documentation/Helix/Add-VerkadaHelixEvent.md b/docs/function-documentation/Helix/Add-VerkadaHelixEvent.md index db0b694..b947dae 100644 --- a/docs/function-documentation/Helix/Add-VerkadaHelixEvent.md +++ b/docs/function-documentation/Helix/Add-VerkadaHelixEvent.md @@ -34,7 +34,7 @@ This will add a new helix event for the current time for the sepcified camera, e ### EXAMPLE 2 ``` -Add-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -attributes $attributes -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Add-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -attributes $attributes -x_verkada_auth_api 'v2_sd78d9verkada-token' This will add a new helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, event ID, and submitted attributes. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Helix/Find-VerkadaHelixEvent.md b/docs/function-documentation/Helix/Find-VerkadaHelixEvent.md index b5d276d..386beb8 100644 --- a/docs/function-documentation/Helix/Find-VerkadaHelixEvent.md +++ b/docs/function-documentation/Helix/Find-VerkadaHelixEvent.md @@ -44,7 +44,7 @@ This will get the helix events for camera_id 6b8731d7-d991-4206-ba71-b5446fa617f ### EXAMPLE 2 ``` -Find-VerkadaHelixEvent -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -startTimeStamp '1/1/2025 08:35:00 -06' -endTimeStamp '1/7/2025 17:00:00 -06' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Find-VerkadaHelixEvent -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -startTimeStamp '1/1/2025 08:35:00 -06' -endTimeStamp '1/7/2025 17:00:00 -06' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will find the helix events for from Jan 1, 2025 at 8:35 AM CST to Jan 7, 2025 at 5:00 APM CST for the sepcified event ID. The token is submitted as parameter in the call. ``` diff --git a/docs/function-documentation/Helix/Get-VerkadaHelixEvent.md b/docs/function-documentation/Helix/Get-VerkadaHelixEvent.md index 520ceb9..a432676 100644 --- a/docs/function-documentation/Helix/Get-VerkadaHelixEvent.md +++ b/docs/function-documentation/Helix/Get-VerkadaHelixEvent.md @@ -34,7 +34,7 @@ This will get the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified c ### EXAMPLE 2 ``` -Get-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Get-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will get the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, and event ID. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Helix/Remove-VerkadaHelixEvent.md b/docs/function-documentation/Helix/Remove-VerkadaHelixEvent.md index cdb4272..046c51d 100644 --- a/docs/function-documentation/Helix/Remove-VerkadaHelixEvent.md +++ b/docs/function-documentation/Helix/Remove-VerkadaHelixEvent.md @@ -33,7 +33,7 @@ This will delete the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcifie ### EXAMPLE 2 ``` -Remove-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Remove-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will delete the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, and event ID. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Helix/Set-VerkadaHelixEvent.md b/docs/function-documentation/Helix/Set-VerkadaHelixEvent.md index ec025df..7f2c455 100644 --- a/docs/function-documentation/Helix/Set-VerkadaHelixEvent.md +++ b/docs/function-documentation/Helix/Set-VerkadaHelixEvent.md @@ -34,7 +34,7 @@ This will get the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified c ### EXAMPLE 2 ``` -Get-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -attributes $attributes -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' +Get-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -attributes $attributes -x_verkada_auth_api 'v2_sd78d9verkada-token' This will get the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, event ID, and submitted attributes. The token is submitted as a parameter in the call. ``` diff --git a/docs/function-documentation/Legacy/Cameras/Get-VerkadaCameraConfig.md b/docs/function-documentation/Legacy/Cameras/Get-VerkadaCameraConfig.md index 54b33c5..d6822f7 100644 --- a/docs/function-documentation/Legacy/Cameras/Get-VerkadaCameraConfig.md +++ b/docs/function-documentation/Legacy/Cameras/Get-VerkadaCameraConfig.md @@ -45,7 +45,7 @@ This will retieve the config information for all of the cameraId's present in th ### EXAMPLE 4 ``` -Get-VerkadaCameraConfig -cameraId '6fbdcd72-a2ec-4016-9c6f-21553a42c998' -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a' -x_verkada_auth 'auth-token-uuid-dscsdc' +Get-VerkadaCameraConfig -cameraId '6fbdcd72-a2ec-4016-9c6f-21553a42c998' -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'v2_sd78d9verkada-token' -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a' -x_verkada_auth 'auth-token-uuid-dscsdc' This will retieve the config information for the camera with Id 6fbdcd72-a2ec-4016-9c6f-21553a42c998. The org_id and tokens are submitted as parameters in the call. ``` diff --git a/docs/reference.md b/docs/reference.md index 5733103..bdd5cd9 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -9,8 +9,10 @@ * [Add-VerkadaAccessUserLicensePlate](function-documentation/Access/Add-VerkadaAccessUserLicensePlate.md) * [Add-VerkadaAccessUserMfaCode](function-documentation/Access/Add-VerkadaAccessUserMfaCode.md) * [Disable-VerkadaAccessUserCard](function-documentation/Access/Disable-VerkadaAccessUserCard.md) +* [Disable-VerkadaAccessUserFaceUnlock](function-documentation/Access/Disable-VerkadaAccessUserFaceUnlock.md) * [Disable-VerkadaAccessUserLicensePlate](function-documentation/Access/Disable-VerkadaAccessUserLicensePlate.md) * [Enable-VerkadaAccessUserCard](function-documentation/Access/Enable-VerkadaAccessUserCard.md) +* [Enable-VerkadaAccessUserFaceUnlock](function-documentation/Access/Enable-VerkadaAccessUserFaceUnlock.md) * [Enable-VerkadaAccessUserLicensePlate](function-documentation/Access/Enable-VerkadaAccessUserLicensePlate.md) * [Get-VerkadaAccessEvents](function-documentation/Access/Get-VerkadaAccessEvents.md) * [Get-VerkadaAccessGroup](function-documentation/Access/Get-VerkadaAccessGroup.md) @@ -28,6 +30,7 @@ * [Remove-VerkadaAccessUserProfilePicture](function-documentation/Access/Remove-VerkadaAccessUserProfilePicture.md) * [Remove-VerkadaAccessUserRemoteUnlock](function-documentation/Access/Remove-VerkadaAccessUserRemoteUnlock.md) * [Send-VerkadaAccessPassInvite](function-documentation/Access/Send-VerkadaAccessPassInvite.md) +* [Send-VerkadaAccessUserFaceUnlockInvite](function-documentation/Access/Send-VerkadaAccessUserFaceUnlockInvite.md) * [Set-VerkadaAccessUserBleUnlock](function-documentation/Access/Set-VerkadaAccessUserBleUnlock.md) * [Set-VerkadaAccessUserEndDate](function-documentation/Access/Set-VerkadaAccessUserEndDate.md) * [Set-VerkadaAccessUserEntryCode](function-documentation/Access/Set-VerkadaAccessUserEntryCode.md) diff --git a/verkadaModule/Public/Access/Add-VerkadaAccessGroup.ps1 b/verkadaModule/Public/Access/Add-VerkadaAccessGroup.ps1 index ec2d3cd..8f710ab 100644 --- a/verkadaModule/Public/Access/Add-VerkadaAccessGroup.ps1 +++ b/verkadaModule/Public/Access/Add-VerkadaAccessGroup.ps1 @@ -15,7 +15,7 @@ function Add-VerkadaAccessGroup{ This will add the access group with the name "NewGroup". The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Add-VerkadaAccessGroup -name 'NewGroup' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Add-VerkadaAccessGroup -name 'NewGroup' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will add the access group with the name "NewGroup". The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Add-VerkadaAccessUserCard.ps1 b/verkadaModule/Public/Access/Add-VerkadaAccessUserCard.ps1 index 9506ee2..c6a4c71 100644 --- a/verkadaModule/Public/Access/Add-VerkadaAccessUserCard.ps1 +++ b/verkadaModule/Public/Access/Add-VerkadaAccessUserCard.ps1 @@ -16,7 +16,7 @@ function Add-VerkadaAccessUserCard{ This will add a badge in the HID format with facility code 111 and card number 55555 to the user specified. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Add-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -type 'HID' -facilityCode 111 -cardNumber 55555 -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Add-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -type 'HID' -facilityCode 111 -cardNumber 55555 -x_verkada_auth_api 'v2_sd78d9verkada-token' This will add an Access credential in the HID format with facility code 111 and card number 55555 to the user specified. The token is submitted as a parameter in the call. .EXAMPLE diff --git a/verkadaModule/Public/Access/Add-VerkadaAccessUserLicensePlate.ps1 b/verkadaModule/Public/Access/Add-VerkadaAccessUserLicensePlate.ps1 index ed8f68c..65961db 100644 --- a/verkadaModule/Public/Access/Add-VerkadaAccessUserLicensePlate.ps1 +++ b/verkadaModule/Public/Access/Add-VerkadaAccessUserLicensePlate.ps1 @@ -16,7 +16,7 @@ function Add-VerkadaAccessUserLicensePlate{ This will add the license plate ABC123 to the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 as a credential. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Add-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -name 'Users License Plate' -active $true -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a' + Add-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -name 'Users License Plate' -active $true -x_verkada_auth_api 'v2_sd78d9verkada-token' This will add the license plate ABC123 to the Access user with externalId newUserUPN@contoso.com as a credential and mark it active. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Add-VerkadaAccessUserMfaCode.ps1 b/verkadaModule/Public/Access/Add-VerkadaAccessUserMfaCode.ps1 index da7d37c..2aa313c 100644 --- a/verkadaModule/Public/Access/Add-VerkadaAccessUserMfaCode.ps1 +++ b/verkadaModule/Public/Access/Add-VerkadaAccessUserMfaCode.ps1 @@ -15,7 +15,7 @@ function Add-VerkadaAccessUserMfaCode{ This adds the MFA code 9567 to the Access user's profile with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Add-VerkadaAccessUserMfaCode -mfaCode '9567' -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Add-VerkadaAccessUserMfaCode -mfaCode '9567' -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This adds the MFA code 9567 to the Access user's profile with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Disable-VerkadaAccessUserCard.ps1 b/verkadaModule/Public/Access/Disable-VerkadaAccessUserCard.ps1 index 5ee23f2..8092309 100644 --- a/verkadaModule/Public/Access/Disable-VerkadaAccessUserCard.ps1 +++ b/verkadaModule/Public/Access/Disable-VerkadaAccessUserCard.ps1 @@ -15,7 +15,7 @@ function Disable-VerkadaAccessUserCard{ This will deactivate the credential with cardId 10110010000000000000001011 for the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 as a credential. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Disable-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '10110010000000000000001011' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Disable-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '10110010000000000000001011' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will deactivate the credential with cardId 10110010000000000000001011 for the Access user with externalId newUserUPN@contoso.com as a credential. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Disable-VerkadaAccessUserFaceUnlock.ps1 b/verkadaModule/Public/Access/Disable-VerkadaAccessUserFaceUnlock.ps1 new file mode 100644 index 0000000..468dbd5 --- /dev/null +++ b/verkadaModule/Public/Access/Disable-VerkadaAccessUserFaceUnlock.ps1 @@ -0,0 +1,107 @@ +function Disable-VerkadaAccessUserFaceUnlock{ + <# + .SYNOPSIS + Disabled Face Unlock using https://apidocs.verkada.com/reference/deletefaceunlockdisableexternaluserviewv2 or https://apidocs.verkada.com/reference/deletefaceunlockdisableuserviewv2. + + .DESCRIPTION + Disable face unlock for a user. This will delete their face credential and disable the face unlock access method. Any pending mobile enrollment invitations for this user will also be deleted. + The reqired token can be directly submitted as a parameter, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. + + .LINK + https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Disable-VerkadaAccessUserFaceUnlock.md + + .EXAMPLE + Disable-VerkadaAccessUserFaceUnlock -externalId 'newUserUPN@contoso.com' + This will disable Face Unlock for the user with externalId newUserUPN@contoso.com and will delete the existing face credential.. The token will be populated from the cache created by Connect-Verkada. + + .EXAMPLE + Disable-VerkadaAccessUserFaceUnlock -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -x_verkada_auth_api 'v2_sd78d9verkada-token' + This will disable Face Unlock for the user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 and will delete the existing face credential. The token is submitted as a parameter in the call. + #> + [CmdletBinding(PositionalBinding = $true, DefaultParameterSetName = 'user_id')] + [Alias("Disable-VrkdaAcUsrFaceUnlk","d-VrkdaAcUsrFaceUnlk")] + param ( + #The UUID of the user + [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'user_id')] + [ValidateNotNullOrEmpty()] + [ValidatePattern('^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$')] + [Alias('user_id')] + [String]$userId, + #unique identifier managed externally provided by the consumer + [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'external_id')] + [ValidateNotNullOrEmpty()] + [Alias('external_id')] + [String]$externalId, + #The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway + [Parameter()] + [ValidateNotNullOrEmpty()] + [String]$x_verkada_auth_api = $Global:verkadaConnection.x_verkada_auth_api, + #The region of the public API to be used + [Parameter()] + [ValidateSet('api','api.eu','api.au')] + [String]$region='api', + #Version designation for which version of the function to use + [Parameter()] + [ValidateNotNullOrEmpty()] + [ValidateSet('v2')] + [string]$version='v2', + #Switch to write errors to file + [Parameter()] + [switch]$errorsToFile + ) + + begin { + #parameter validation + if ([string]::IsNullOrEmpty($x_verkada_auth_api)) {throw "x_verkada_auth_api is missing but is required!"} + $myErrors = @() + } #end begin + + process { + switch ($PSCmdlet.ParameterSetName) { + 'external_id' { + $url = "https://$($region).verkada.com/$($version)/access/external_users/$($externalId)/face_unlock" + if ([string]::IsNullOrEmpty($externalId)) {throw "externalId is missing but is required!"} + $ident = $externalId + } + 'user_id' { + $url = "https://$($region).verkada.com/$($version)/access/users/$($userId)/face_unlock" + if ([string]::IsNullOrEmpty($userId)) {throw "userId is missing but is required!"} + $ident = $userId + } + } + $body_params = @{} + + $query_params = @{} + + try { + $response = Invoke-VerkadaRestMethod $url $x_verkada_auth_api $query_params -body_params $body_params -method DELETE + "Successfully disabled Face Unlock for $($ident) $($response | ConvertTo-Json -Compress)" + } + catch [Microsoft.PowerShell.Commands.HttpResponseException] { + $err = $_.ErrorDetails | ConvertFrom-Json + $errorMes = $_ | Convertto-Json -WarningAction SilentlyContinue + $err | Add-Member -NotePropertyName StatusCode -NotePropertyValue (($errorMes | ConvertFrom-Json -Depth 100 -WarningAction SilentlyContinue).Exception.Response.StatusCode) -Force + $msg = "$($err.StatusCode) - $($err.message)" + $msg += ": $(($query_params + $body_params) | ConvertTo-Json -Compress)" + Write-Error $msg + $myErrors += $msg + $msg = $null + } + catch [VerkadaRestMethodException] { + $msg = $_.ToString() + $msg += ": $(($query_params + $body_params) | ConvertTo-Json -Compress)" + Write-Error $msg + $myErrors += $msg + $msg = $null + } + } #end process + + end { + if ($errorsToFile.IsPresent){ + if (![string]::IsNullOrEmpty($myErrors)){ + Get-Date | Out-File ./errors.txt -Append + $myErrors | Out-File ./errors.txt -Append + } + } + } #end end +} #end function \ No newline at end of file diff --git a/verkadaModule/Public/Access/Disable-VerkadaAccessUserLicensePlate.ps1 b/verkadaModule/Public/Access/Disable-VerkadaAccessUserLicensePlate.ps1 index b22e5e1..1accf3a 100644 --- a/verkadaModule/Public/Access/Disable-VerkadaAccessUserLicensePlate.ps1 +++ b/verkadaModule/Public/Access/Disable-VerkadaAccessUserLicensePlate.ps1 @@ -15,7 +15,7 @@ function Disable-VerkadaAccessUserLicensePlate{ This will deactivate the license plate ABC123 for the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 as a credential. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Disable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Disable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will deactivate the license plate ABC123 for the Access user with externalId newUserUPN@contoso.com as a credential. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Enable-VerkadaAccessUserCard.ps1 b/verkadaModule/Public/Access/Enable-VerkadaAccessUserCard.ps1 index 4bf8225..e87a06f 100644 --- a/verkadaModule/Public/Access/Enable-VerkadaAccessUserCard.ps1 +++ b/verkadaModule/Public/Access/Enable-VerkadaAccessUserCard.ps1 @@ -15,7 +15,7 @@ function Enable-VerkadaAccessUserCard{ This will activate the credential with cardId 10110010000000000000001011 for the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 as a credential. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Enable-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '3f3b3e4d-1a67-4b88-a321-43c5e502991c' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Enable-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '3f3b3e4d-1a67-4b88-a321-43c5e502991c' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will activate the credential with cardId 10110010000000000000001011 for the Access user with externalId newUserUPN@contoso.com as a credential. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Enable-VerkadaAccessUserFaceUnlock.ps1 b/verkadaModule/Public/Access/Enable-VerkadaAccessUserFaceUnlock.ps1 new file mode 100644 index 0000000..1aad559 --- /dev/null +++ b/verkadaModule/Public/Access/Enable-VerkadaAccessUserFaceUnlock.ps1 @@ -0,0 +1,166 @@ +function Enable-VerkadaAccessUserFaceUnlock{ + <# + .SYNOPSIS + Enables face unlock for an Access user using https://apidocs.verkada.com/reference/postfaceunlockcopyuserphotoexternaluserviewv2, https://apidocs.verkada.com/reference/postfaceunlockuploadphotoexternaluserviewv2, https://apidocs.verkada.com/reference/postfaceunlockcopyuserphotouserviewv2, and https://apidocs.verkada.com/reference/postfaceunlockuploadphotouserviewv2 + + .DESCRIPTION + Enable face unlock for a user by using their existing profile photo by uploading a new photo. This will create a face credential from the user's profile photo or by providing a photo via uplaod. If the user already has a face credential and overwrite is False, the request will fail. The profile photo must meet quality requirements for face recognition. + The reqired token can be directly submitted as a parameter, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. + + .LINK + https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Enable-VerkadaAccessUserFaceUnlock.md + + .EXAMPLE + Enable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' + This will enable Face Unlock for the user with externalId newUserUPN@contoso.com using their existing AC profile photo. The token will be populated from the cache created by Connect-Verkada. + + .EXAMPLE + Enable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -imagePath './myPicture.png' -overwrite $true -x_verkada_auth_api 'v2_sd78d9verkada-token' + This will enable Face Unlock for the user with externalId newUserUPN@contoso.com using the photo specified in the imagePath, ./myPicture.png, and will overwrite the existing face credential if it exists. The token is submitted as a parameter in the call. + + .EXAMPLE + Enable-VerkadaAccessUserLicensePlate -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' + This will enable Face Unlock for the user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 using their existing AC profile photo. The token will be populated from the cache created by Connect-Verkada. + + .EXAMPLE + Enable-VerkadaAccessUserLicensePlate -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -imagePath './801c9551-b04c-4293-84ad-b0a6aa0588b3.png' -overwrite $true -x_verkada_auth_api 'v2_sd78d9verkada-token' + This will enable Face Unlock for the user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 using the photo specified in the imagePath, ./801c9551-b04c-4293-84ad-b0a6aa0588b3.png, and will overwrite the existing face credential if it exists. The token is submitted as a parameter in the call. + #> + [CmdletBinding(PositionalBinding = $true, DefaultParameterSetName = 'external_profilePhoto')] + [Alias("Enable-VrkdaAcUsrFaceUnlk","e-VrkdaAcUsrFaceUnlk")] + param ( + #The UUID of the user + [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'user_profilePhoto')] + [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'user_upload')] + [ValidateNotNullOrEmpty()] + [ValidatePattern('^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$')] + [Alias('user_id')] + [String]$userId, + #unique identifier managed externally provided by the consumer + [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'external_profilePhoto')] + [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'external_upload')] + [ValidateNotNullOrEmpty()] + [Alias('external_id')] + [String]$externalId, + #This is the path the image will be uploaded from + [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'user_upload')] + [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'external_upload')] + [ValidateNotNullOrEmpty()] + [ValidatePattern('^.*\.(jpg|jpeg|png)$')] + [string]$imagePath, + #The flag that states whether to overwrite the existing profile photo + [Parameter(ValueFromPipelineByPropertyName = $true)] + [bool]$overwrite=$false, + #The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway + [Parameter()] + [ValidateNotNullOrEmpty()] + [String]$x_verkada_auth_api = $Global:verkadaConnection.x_verkada_auth_api, + #The region of the public API to be used + [Parameter()] + [ValidateSet('api','api.eu','api.au')] + [String]$region='api', + #Version designation for which version of the function to use + [Parameter()] + [ValidateNotNullOrEmpty()] + [ValidateSet('v2')] + [string]$version='v2', + #Switch to write errors to file + [Parameter()] + [switch]$errorsToFile + ) + + begin { + #parameter validation + if ([string]::IsNullOrEmpty($x_verkada_auth_api)) {throw "x_verkada_auth_api is missing but is required!"} + $myErrors = @() + } #end begin + + process { + switch ($PSCmdlet.ParameterSetName) { + 'external_profilePhoto' { + $url = "https://$($region).verkada.com/$($version)/access/external_users/$($externalId)/face_unlock/copy_user_photo" + if ([string]::IsNullOrEmpty($externalId)) {throw "externalId is missing but is required!"} + + #check to see if an AC profile photo exists + if ((Get-VerkadaAccessUser -externalId $externalId -x_verkada_auth_api $x_verkada_auth_api).has_profile_photo){ + $upload = $false + } else { + throw "$($externalId) has no current AC profile photo" + } + } + 'external_upload' { + $url = "https://$($region).verkada.com/$($version)/access/external_users/$($externalId)/face_unlock/upload_photo" + if ([string]::IsNullOrEmpty($externalId)) {throw "externalId is missing but is required!"} + if ([string]::IsNullOrEmpty($imagePath)) {throw "imagePath is missing but is required!"} + $upload = $true + + $form = @{ + file = Get-Item -Path $imagePath + 'overwrite' = $overwrite + } + } + 'user_profilePhoto' { + $url = "https://$($region).verkada.com/$($version)/access/users/$($userId)/face_unlock/copy_user_photo" + if ([string]::IsNullOrEmpty($userId)) {throw "userId is missing but is required!"} + + #check to see if an AC profile photo exists + if ((Get-VerkadaAccessUser -userId $userId -x_verkada_auth_api $x_verkada_auth_api).has_profile_photo){ + $upload = $false + } else { + throw "$($userId) has no current AC profile photo" + } + } + 'user_upload' { + $url = "https://$($region).verkada.com/$($version)/access/users/$($userId)/face_unlock/upload_photo" + if ([string]::IsNullOrEmpty($userId)) {throw "userId is missing but is required!"} + if ([string]::IsNullOrEmpty($imagePath)) {throw "imagePath is missing but is required!"} + $upload = $true + + $form = @{ + file = Get-Item -Path $imagePath + 'overwrite' = $overwrite + } + } + } + + $body_params = @{} + + $query_params = @{} + + try { + if ($upload) { + $response = Invoke-VerkadaFormCall $url $form -query_params $query_params -x_verkada_auth_api $x_verkada_auth_api -method POST + return "Successfully uploaded $imagePath to $($response | ConvertTo-Json -Compress)" + } else { + $response = Invoke-VerkadaRestMethod $url $x_verkada_auth_api $query_params -body_params $body_params -method POST + return $response + } + } + catch [Microsoft.PowerShell.Commands.HttpResponseException] { + $err = $_.ErrorDetails | ConvertFrom-Json + $errorMes = $_ | Convertto-Json -WarningAction SilentlyContinue + $err | Add-Member -NotePropertyName StatusCode -NotePropertyValue (($errorMes | ConvertFrom-Json -Depth 100 -WarningAction SilentlyContinue).Exception.Response.StatusCode) -Force + $msg = "$($err.StatusCode) - $($err.message)" + $msg += ": $(($query_params + $body_params) | ConvertTo-Json -Compress)" + Write-Error $msg + $myErrors += $msg + $msg = $null + } + catch [VerkadaRestMethodException] { + $msg = $_.ToString() + $msg += ": $(($query_params + $body_params) | ConvertTo-Json -Compress)" + Write-Error $msg + $myErrors += $msg + $msg = $null + } + } #end process + + end { + if ($errorsToFile.IsPresent){ + if (![string]::IsNullOrEmpty($myErrors)){ + Get-Date | Out-File ./errors.txt -Append + $myErrors | Out-File ./errors.txt -Append + } + } + } #end end +} #end function \ No newline at end of file diff --git a/verkadaModule/Public/Access/Enable-VerkadaAccessUserLicensePlate.ps1 b/verkadaModule/Public/Access/Enable-VerkadaAccessUserLicensePlate.ps1 index ced924c..8d486ff 100644 --- a/verkadaModule/Public/Access/Enable-VerkadaAccessUserLicensePlate.ps1 +++ b/verkadaModule/Public/Access/Enable-VerkadaAccessUserLicensePlate.ps1 @@ -15,7 +15,7 @@ function Enable-VerkadaAccessUserLicensePlate{ This will activate the license plate ABC123 for the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 as a credential. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Enable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Enable-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will activate the license plate ABC123 for the Access user with externalId newUserUPN@contoso.com as a credential. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Get-VerkadaAccessEvents.ps1 b/verkadaModule/Public/Access/Get-VerkadaAccessEvents.ps1 index 3980f1f..18670ad 100644 --- a/verkadaModule/Public/Access/Get-VerkadaAccessEvents.ps1 +++ b/verkadaModule/Public/Access/Get-VerkadaAccessEvents.ps1 @@ -15,7 +15,7 @@ function Get-VerkadaAccessEvents{ This will return all the access events from 1 hour in the past until present. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Get-VerkadaAccessEvents -start_time 'January 1, 2025 9:00:00AM' -end_time 'February 8, 2025 10:30:00PM' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Get-VerkadaAccessEvents -start_time 'January 1, 2025 9:00:00AM' -end_time 'February 8, 2025 10:30:00PM' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return all the access events from Jan 1 at 9am to Feb 8 at 10:30pm. The token is submitted as parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Get-VerkadaAccessGroup.ps1 b/verkadaModule/Public/Access/Get-VerkadaAccessGroup.ps1 index 28f2707..d52e378 100644 --- a/verkadaModule/Public/Access/Get-VerkadaAccessGroup.ps1 +++ b/verkadaModule/Public/Access/Get-VerkadaAccessGroup.ps1 @@ -15,7 +15,7 @@ function Get-VerkadaAccessGroup{ This will return the Access Group with userId "7858d17a-3f72-4506-8532-a4b6ba233c5e". The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Get-VerkadaAccessGroup -groupId '7858d17a-3f72-4506-8532-a4b6ba233c5e' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Get-VerkadaAccessGroup -groupId '7858d17a-3f72-4506-8532-a4b6ba233c5e' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return the Access Group with userId "7858d17a-3f72-4506-8532-a4b6ba233c5e". The token is submitted as a parameter in the call. .EXAMPLE diff --git a/verkadaModule/Public/Access/Get-VerkadaAccessUser.ps1 b/verkadaModule/Public/Access/Get-VerkadaAccessUser.ps1 index 78bfef1..76d10b2 100644 --- a/verkadaModule/Public/Access/Get-VerkadaAccessUser.ps1 +++ b/verkadaModule/Public/Access/Get-VerkadaAccessUser.ps1 @@ -15,7 +15,7 @@ function Get-VerkadaAccessUser{ This will retrieve the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Get-VerkadaAccessUser -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Get-VerkadaAccessUser -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will retrieve the Access user with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Get-VerkadaAccessUserProfilePicture.ps1 b/verkadaModule/Public/Access/Get-VerkadaAccessUserProfilePicture.ps1 index 56b431c..c430f5d 100644 --- a/verkadaModule/Public/Access/Get-VerkadaAccessUserProfilePicture.ps1 +++ b/verkadaModule/Public/Access/Get-VerkadaAccessUserProfilePicture.ps1 @@ -15,7 +15,7 @@ function Get-VerkadaAccessUserProfilePicture{ This downloads the Access user's, with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3, picture to ./MyProfilePics/801c9551-b04c-4293-84ad-b0a6aa0588b3.jpg. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Export-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -outPath './MyProfilePics' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Export-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -outPath './MyProfilePics' -x_verkada_auth_api 'v2_sd78d9verkada-token' This downloads the Access user's, with externalId newUserUPN@contoso.com picture to ./MyProfilePics/newUserUPN.jpg. The token is submitted as parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Read-VerkadaAccessGroups.ps1 b/verkadaModule/Public/Access/Read-VerkadaAccessGroups.ps1 index a16daa0..67c8aa8 100644 --- a/verkadaModule/Public/Access/Read-VerkadaAccessGroups.ps1 +++ b/verkadaModule/Public/Access/Read-VerkadaAccessGroups.ps1 @@ -15,7 +15,7 @@ function Read-VerkadaAccessGroups{ This will return aa the Access Groups. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Read-VerkadaAccessGroups -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Read-VerkadaAccessGroups -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return aa the Access Groups. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Read-VerkadaAccessUsers.ps1 b/verkadaModule/Public/Access/Read-VerkadaAccessUsers.ps1 index 5f80149..4cbdfb9 100644 --- a/verkadaModule/Public/Access/Read-VerkadaAccessUsers.ps1 +++ b/verkadaModule/Public/Access/Read-VerkadaAccessUsers.ps1 @@ -19,7 +19,7 @@ function Read-VerkadaAccessUsers{ This will return all the active access users in an organization. The token is submitted as a parameter in the call. .EXAMPLE - Read-VerkadaAccessUsers -version v1 -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Read-VerkadaAccessUsers -version v1 -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return all the active access users in an organization using the Command v1 public API endpoint. The token is submitted as a parameter in the call. .EXAMPLE diff --git a/verkadaModule/Public/Access/Remove-VerkadaAccessGroup.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessGroup.ps1 index 48d3f2d..3ca3ee1 100644 --- a/verkadaModule/Public/Access/Remove-VerkadaAccessGroup.ps1 +++ b/verkadaModule/Public/Access/Remove-VerkadaAccessGroup.ps1 @@ -15,7 +15,7 @@ function Remove-VerkadaAccessGroup{ This will delete the Access group with the groupId 2d64e7de-fd95-48be-8b5c-7a23bde94f52. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaAccessGroup -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaAccessGroup -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will delete the Access group with the groupId 2d64e7de-fd95-48be-8b5c-7a23bde94f52. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Remove-VerkadaAccessUserBleUnlock.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserBleUnlock.ps1 index 5dbb63e..b9465fc 100644 --- a/verkadaModule/Public/Access/Remove-VerkadaAccessUserBleUnlock.ps1 +++ b/verkadaModule/Public/Access/Remove-VerkadaAccessUserBleUnlock.ps1 @@ -15,7 +15,7 @@ function Remove-VerkadaAccessUserBleUnlock{ This will deactivate the Access user's Bluetooth unlock ability with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaAccessUserBleUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaAccessUserBleUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will deactivate the Access user's Bluetooth unlock ability with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Remove-VerkadaAccessUserCard.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserCard.ps1 index db7259d..624f7b5 100644 --- a/verkadaModule/Public/Access/Remove-VerkadaAccessUserCard.ps1 +++ b/verkadaModule/Public/Access/Remove-VerkadaAccessUserCard.ps1 @@ -15,7 +15,7 @@ function Remove-VerkadaAccessUserCard{ This will delete the credential with cardId 10110010000000000000001011 for the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 as a credential. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '10110010000000000000001011' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -cardId '10110010000000000000001011' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will delete the credential with cardId 10110010000000000000001011 for the Access user with externalId newUserUPN@contoso.com as a credential. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Remove-VerkadaAccessUserEntryCode.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserEntryCode.ps1 index d1fbeb6..0a0692d 100644 --- a/verkadaModule/Public/Access/Remove-VerkadaAccessUserEntryCode.ps1 +++ b/verkadaModule/Public/Access/Remove-VerkadaAccessUserEntryCode.ps1 @@ -15,7 +15,7 @@ function Remove-VerkadaAccessUserEntryCode{ This will remove the Access user's entry code with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaAccessUserEntryCode -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaAccessUserEntryCode -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will remove the Access user's entry code with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Remove-VerkadaAccessUserFromGroup.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserFromGroup.ps1 index 762191d..9cfe82c 100644 --- a/verkadaModule/Public/Access/Remove-VerkadaAccessUserFromGroup.ps1 +++ b/verkadaModule/Public/Access/Remove-VerkadaAccessUserFromGroup.ps1 @@ -15,7 +15,7 @@ function Remove-VerkadaAccessUserFromGroup{ This will remove the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 from the group with groupId 2d64e7de-fd95-48be-8b5c-7a23bde94f52. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaAccessUserFromGroup -externalId 'newUserUPN@contoso.com' -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaAccessUserFromGroup -externalId 'newUserUPN@contoso.com' -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will remove the Access user with externalId newUserUPN@contoso.com from the group with groupId 2d64e7de-fd95-48be-8b5c-7a23bde94f52. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Remove-VerkadaAccessUserLicensePlate.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserLicensePlate.ps1 index 97d0dea..ab83335 100644 --- a/verkadaModule/Public/Access/Remove-VerkadaAccessUserLicensePlate.ps1 +++ b/verkadaModule/Public/Access/Remove-VerkadaAccessUserLicensePlate.ps1 @@ -15,7 +15,7 @@ function Remove-VerkadaAccessUserLicensePlate{ This will remove license plate ABC123 as a credential from the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will remove license plate ABC123 as a credential from the Access user with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Remove-VerkadaAccessUserMfaCode.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserMfaCode.ps1 index f4d9392..f3a3fe8 100644 --- a/verkadaModule/Public/Access/Remove-VerkadaAccessUserMfaCode.ps1 +++ b/verkadaModule/Public/Access/Remove-VerkadaAccessUserMfaCode.ps1 @@ -15,7 +15,7 @@ function Remove-VerkadaAccessUserMfaCode{ This deletes the MFA code 9567 from the Access user's profile with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaAccessUserMfaCode -mfaCode '9567' -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaAccessUserMfaCode -mfaCode '9567' -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This deletes the MFA code 9567 from the Access user's profile with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Remove-VerkadaAccessUserProfilePicture.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserProfilePicture.ps1 index 4e24d4b..b718363 100644 --- a/verkadaModule/Public/Access/Remove-VerkadaAccessUserProfilePicture.ps1 +++ b/verkadaModule/Public/Access/Remove-VerkadaAccessUserProfilePicture.ps1 @@ -15,7 +15,7 @@ function Remove-VerkadaAccessUserProfilePicture{ This removes the Access user's profile picture with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This removes the Access user's profile picture with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Remove-VerkadaAccessUserRemoteUnlock.ps1 b/verkadaModule/Public/Access/Remove-VerkadaAccessUserRemoteUnlock.ps1 index 33bb5fe..6c47719 100644 --- a/verkadaModule/Public/Access/Remove-VerkadaAccessUserRemoteUnlock.ps1 +++ b/verkadaModule/Public/Access/Remove-VerkadaAccessUserRemoteUnlock.ps1 @@ -15,7 +15,7 @@ function Remove-VerkadaAccessUserRemoteUnlock{ This will deactivate the Access user's Remote unlock ability with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaAccessUserRemoteUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaAccessUserRemoteUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will deactivate the Access user's Remote unlock ability with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Send-VerkadaAccessPassInvite.ps1 b/verkadaModule/Public/Access/Send-VerkadaAccessPassInvite.ps1 index a21c13a..4dd044f 100644 --- a/verkadaModule/Public/Access/Send-VerkadaAccessPassInvite.ps1 +++ b/verkadaModule/Public/Access/Send-VerkadaAccessPassInvite.ps1 @@ -19,7 +19,7 @@ function Send-VerkadaAccessPassInvite{ This will send an email invite to an Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 and activate BLE unlocks. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Send-VerkadaAccessPassInvite -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Send-VerkadaAccessPassInvite -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will send an email invite to an Access user with -externalId 'newUserUPN@contoso.com'. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Send-VerkadaAccessUserFaceUnlockInvite.ps1 b/verkadaModule/Public/Access/Send-VerkadaAccessUserFaceUnlockInvite.ps1 new file mode 100644 index 0000000..6780c2d --- /dev/null +++ b/verkadaModule/Public/Access/Send-VerkadaAccessUserFaceUnlockInvite.ps1 @@ -0,0 +1,119 @@ +function Send-VerkadaAccessUserFaceUnlockInvite{ + <# + .SYNOPSIS + Sends an invite for an Access user to enrol their face to enable Face Unlock using https://apidocs.verkada.com/reference/postfaceunlockinviteexternaluserviewv2 or https://apidocs.verkada.com/reference/postfaceunlockinviteuserviewv2 + + .DESCRIPTION + Enable face unlock for a user by sending them an invitation to enroll their face via mobile device. An email will be sent to the user with a link to complete the enrollment process. If the user already has a face credential and overwrite is False, the request will fail. When overwrite is True, the invitation is sent and the user can upload a new photo which will replace the existing credential. + The reqired token can be directly submitted as a parameter, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. + + .LINK + https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaAccessUserFaceUnlockInvite.md + + .EXAMPLE + Send-VerkadaAccessUserFaceUnlockInvite -externalId 'newUserUPN@contoso.com' + This will send a Face Unlock invite to the user with externalId newUserUPN@contoso.com. The token will be populated from the cache created by Connect-Verkada. + + .EXAMPLE + Send-VerkadaAccessUserFaceUnlockInvite -externalId 'newUserUPN@contoso.com' -overwrite $true -x_verkada_auth_api 'v2_sd78d9verkada-token' + This will send a Face Unlock invite to the user with externalId newUserUPN@contoso.com and will overwrite the existing face credential if it exists. The token is submitted as a parameter in the call. + + .EXAMPLE + Send-VerkadaAccessUserFaceUnlockInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -method 'email' + This will send a Face Unlock invite to the user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 via email only, not the default sms and email. The token will be populated from the cache created by Connect-Verkada. + #> + [CmdletBinding(PositionalBinding = $true, DefaultParameterSetName = 'user_id')] + [Alias("Send-VrkdaAcUsrUsrFaceInv","sd-VrkdaAcUsrUsrFaceInv")] + param ( + #The UUID of the user + [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'user_id')] + [ValidateNotNullOrEmpty()] + [ValidatePattern('^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$')] + [Alias('user_id')] + [String]$userId, + #unique identifier managed externally provided by the consumer + [Parameter(ValueFromPipelineByPropertyName = $true, Mandatory = $true, ParameterSetName = 'external_id')] + [ValidateNotNullOrEmpty()] + [Alias('external_id')] + [String]$externalId, + #The flag that states whether to overwrite the existing profile photo + [Parameter(ValueFromPipelineByPropertyName = $true)] + [bool]$overwrite=$false, + #The method to send the invite + [Parameter(ValueFromPipelineByPropertyName = $true)] + [ValidateSet('email','sms')] + [String[]]$method=@('email','sms'), + #The public API token obatined via the Login endpoint to be used for calls that hit the public API gateway + [Parameter()] + [ValidateNotNullOrEmpty()] + [String]$x_verkada_auth_api = $Global:verkadaConnection.x_verkada_auth_api, + #The region of the public API to be used + [Parameter()] + [ValidateSet('api','api.eu','api.au')] + [String]$region='api', + #Version designation for which version of the function to use + [Parameter()] + [ValidateNotNullOrEmpty()] + [ValidateSet('v2')] + [string]$version='v2', + #Switch to write errors to file + [Parameter()] + [switch]$errorsToFile + ) + + begin { + #parameter validation + if ([string]::IsNullOrEmpty($x_verkada_auth_api)) {throw "x_verkada_auth_api is missing but is required!"} + $myErrors = @() + } #end begin + + process { + switch ($PSCmdlet.ParameterSetName) { + 'external_id' { + $url = "https://$($region).verkada.com/$($version)/access/external_users/$($externalId)/face_unlock/invite" + if ([string]::IsNullOrEmpty($externalId)) {throw "externalId is missing but is required!"} + } + 'user_id' { + $url = "https://$($region).verkada.com/$($version)/access/users/$($userId)/face_unlock/invite" + if ([string]::IsNullOrEmpty($userId)) {throw "userId is missing but is required!"} + } + } + + $body_params = @{ + 'invitation_methods' = $method + } + + $query_params = @{} + + try { + $response = Invoke-VerkadaRestMethod $url $x_verkada_auth_api $query_params -body_params $body_params -method POST + return $response + } + catch [Microsoft.PowerShell.Commands.HttpResponseException] { + $err = $_.ErrorDetails | ConvertFrom-Json + $errorMes = $_ | Convertto-Json -WarningAction SilentlyContinue + $err | Add-Member -NotePropertyName StatusCode -NotePropertyValue (($errorMes | ConvertFrom-Json -Depth 100 -WarningAction SilentlyContinue).Exception.Response.StatusCode) -Force + $msg = "$($err.StatusCode) - $($err.message)" + $msg += ": $(($query_params + $body_params) | ConvertTo-Json -Compress)" + Write-Error $msg + $myErrors += $msg + $msg = $null + } + catch [VerkadaRestMethodException] { + $msg = $_.ToString() + $msg += ": $(($query_params + $body_params) | ConvertTo-Json -Compress)" + Write-Error $msg + $myErrors += $msg + $msg = $null + } + } #end process + + end { + if ($errorsToFile.IsPresent){ + if (![string]::IsNullOrEmpty($myErrors)){ + Get-Date | Out-File ./errors.txt -Append + $myErrors | Out-File ./errors.txt -Append + } + } + } #end end +} #end function \ No newline at end of file diff --git a/verkadaModule/Public/Access/Set-VerkadaAccessUserBleUnlock.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserBleUnlock.ps1 index faab393..2c2e3d2 100644 --- a/verkadaModule/Public/Access/Set-VerkadaAccessUserBleUnlock.ps1 +++ b/verkadaModule/Public/Access/Set-VerkadaAccessUserBleUnlock.ps1 @@ -19,7 +19,7 @@ function Set-VerkadaAccessUserBleUnlock{ This will activate the Access user's Bluetooth unlock ability with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 and send an email invite for the Pass app. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Set-VerkadaAccessUserBleUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Set-VerkadaAccessUserBleUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will activate the Access user's Bluetooth unlock ability with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Set-VerkadaAccessUserEndDate.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserEndDate.ps1 index dc1f8f5..9043798 100644 --- a/verkadaModule/Public/Access/Set-VerkadaAccessUserEndDate.ps1 +++ b/verkadaModule/Public/Access/Set-VerkadaAccessUserEndDate.ps1 @@ -15,7 +15,7 @@ function Set-VerkadaAccessUserEndDate{ This sets the Access user's access to end at 8am on Nov 28, 2025 with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Set-VerkadaAccessUserEndDate -externalId 'newUserUPN@contoso.com' -endDate (Get-Date) -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Set-VerkadaAccessUserEndDate -externalId 'newUserUPN@contoso.com' -endDate (Get-Date) -x_verkada_auth_api 'v2_sd78d9verkada-token' This sets the Access user's access to end immediately since you are specifiying the current date and time with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Set-VerkadaAccessUserEntryCode.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserEntryCode.ps1 index b4f17ee..3a2f2d0 100644 --- a/verkadaModule/Public/Access/Set-VerkadaAccessUserEntryCode.ps1 +++ b/verkadaModule/Public/Access/Set-VerkadaAccessUserEntryCode.ps1 @@ -15,7 +15,7 @@ function Set-VerkadaAccessUserEntryCode{ This will set an entry code of 12345 to the user specified. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Set-VerkadaAccessUserEntryCode -externalId 'newUserUPN@contoso.com' -entryCode '12345' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Set-VerkadaAccessUserEntryCode -externalId 'newUserUPN@contoso.com' -entryCode '12345' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will set an entry code of 12345 to the user specified. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Set-VerkadaAccessUserGroup.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserGroup.ps1 index f7d7bd0..515413b 100644 --- a/verkadaModule/Public/Access/Set-VerkadaAccessUserGroup.ps1 +++ b/verkadaModule/Public/Access/Set-VerkadaAccessUserGroup.ps1 @@ -19,7 +19,7 @@ function Set-VerkadaAccessUserGroup{ This adds the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 to Access group with groupName MyAccessGroup. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Set-VerkadaAccessUserGroup -externalId 'newUserUPN@contoso.com' -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Set-VerkadaAccessUserGroup -externalId 'newUserUPN@contoso.com' -groupId '2d64e7de-fd95-48be-8b5c-7a23bde94f52' -x_verkada_auth_api 'v2_sd78d9verkada-token' This adds the Access user uwith xternalId newUserUPN@contoso.com to Access group with groupId 2d64e7de-fd95-48be-8b5c-7a23bde94f52. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true, DefaultParameterSetName = 'groupId')] diff --git a/verkadaModule/Public/Access/Set-VerkadaAccessUserProfilePicture.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserProfilePicture.ps1 index fa0ed1d..3458658 100644 --- a/verkadaModule/Public/Access/Set-VerkadaAccessUserProfilePicture.ps1 +++ b/verkadaModule/Public/Access/Set-VerkadaAccessUserProfilePicture.ps1 @@ -15,7 +15,7 @@ function Set-VerkadaAccessUserProfilePicture{ This sets the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 to use the picture specified at path ./myPicture.jpg. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Set-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -imagePath './myPicture.png' -overwrite $true -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Set-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -imagePath './myPicture.png' -overwrite $true -x_verkada_auth_api 'v2_sd78d9verkada-token' This sets the Access user with externalId newUserUPN@contoso.com to use the picture specified at path ./myPicture.png and will overwrite the existing photo. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Set-VerkadaAccessUserRemoteUnlock.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserRemoteUnlock.ps1 index 1ad2aaa..44e52dd 100644 --- a/verkadaModule/Public/Access/Set-VerkadaAccessUserRemoteUnlock.ps1 +++ b/verkadaModule/Public/Access/Set-VerkadaAccessUserRemoteUnlock.ps1 @@ -15,7 +15,7 @@ function Set-VerkadaAccessUserRemoteUnlock{ This will activate the Access user's Remote unlock ability with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Set-VerkadaAccessUserRemoteUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Set-VerkadaAccessUserRemoteUnlock -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will activate the Access user's Remote unlock ability with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Access/Set-VerkadaAccessUserStartDate.ps1 b/verkadaModule/Public/Access/Set-VerkadaAccessUserStartDate.ps1 index a250c42..17fcc0c 100644 --- a/verkadaModule/Public/Access/Set-VerkadaAccessUserStartDate.ps1 +++ b/verkadaModule/Public/Access/Set-VerkadaAccessUserStartDate.ps1 @@ -15,7 +15,7 @@ function Set-VerkadaAccessUserStartDate{ This sets the Access user's access to start at 8am on Jan 28, 2022 with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Set-VerkadaAccessUserStartDate -externalId 'newUserUPN@contoso.com' -startDate (Get-Date) -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Set-VerkadaAccessUserStartDate -externalId 'newUserUPN@contoso.com' -startDate (Get-Date) -x_verkada_auth_api 'v2_sd78d9verkada-token' This sets the Access user's access to start immediately since you are specifiying the current date and time with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Cameras/Add-VerkadaCameraLicensePlateOfInterest.ps1 b/verkadaModule/Public/Cameras/Add-VerkadaCameraLicensePlateOfInterest.ps1 index 091b0b0..54ea21a 100644 --- a/verkadaModule/Public/Cameras/Add-VerkadaCameraLicensePlateOfInterest.ps1 +++ b/verkadaModule/Public/Cameras/Add-VerkadaCameraLicensePlateOfInterest.ps1 @@ -23,7 +23,7 @@ function Add-VerkadaCameraLicensePlateOfInterest{ The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Add-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Add-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate' -x_verkada_auth_api 'v2_sd78d9verkada-token' The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Cameras/Get-VerkadaCameraCloudBackupSettings.ps1 b/verkadaModule/Public/Cameras/Get-VerkadaCameraCloudBackupSettings.ps1 index 4ea4b3c..eb30902 100644 --- a/verkadaModule/Public/Cameras/Get-VerkadaCameraCloudBackupSettings.ps1 +++ b/verkadaModule/Public/Cameras/Get-VerkadaCameraCloudBackupSettings.ps1 @@ -15,7 +15,7 @@ function Get-VerkadaCameraCloudBackupSettings{ This will get the cloud backup settings of camera cwdfwfw-3f3-cwdf2-cameraId. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Get-VerkadaCameraCloudBackupSettings -camera_id "cwdfwfw-3f3-cwdf2-cameraId" -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Get-VerkadaCameraCloudBackupSettings -camera_id "cwdfwfw-3f3-cwdf2-cameraId" -x_verkada_auth_api 'v2_sd78d9verkada-token' This will get the cloud backup settings of camera cwdfwfw-3f3-cwdf2-cameraId. The token is submitted as a parameter in the call. .EXAMPLE diff --git a/verkadaModule/Public/Cameras/Get-VerkadaCameras.ps1 b/verkadaModule/Public/Cameras/Get-VerkadaCameras.ps1 index cb02763..290f648 100644 --- a/verkadaModule/Public/Cameras/Get-VerkadaCameras.ps1 +++ b/verkadaModule/Public/Cameras/Get-VerkadaCameras.ps1 @@ -15,7 +15,7 @@ function Get-VerkadaCameras{ This will return all the cameras in the org. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Get-VerkadaCameras -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Get-VerkadaCameras -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return all the cameras in the org. The token is submitted as a parameter in the call. .EXAMPLE diff --git a/verkadaModule/Public/Cameras/Get-VerkadaLicensePlatesOfInterest.ps1 b/verkadaModule/Public/Cameras/Get-VerkadaLicensePlatesOfInterest.ps1 index d77cdec..9c7c32b 100644 --- a/verkadaModule/Public/Cameras/Get-VerkadaLicensePlatesOfInterest.ps1 +++ b/verkadaModule/Public/Cameras/Get-VerkadaLicensePlatesOfInterest.ps1 @@ -19,7 +19,7 @@ function Get-VerkadaLicensePlatesOfInterest{ The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Get-VerkadaLicensePlatesOfInterest -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Get-VerkadaLicensePlatesOfInterest -x_verkada_auth_api 'v2_sd78d9verkada-token' The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.ps1 b/verkadaModule/Public/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.ps1 index 51d205f..0a5d898 100644 --- a/verkadaModule/Public/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.ps1 +++ b/verkadaModule/Public/Cameras/Remove-VerkadaCameraLicensePlateOfInterest.ps1 @@ -23,7 +23,7 @@ function Remove-VerkadaCameraLicensePlateOfInterest{ The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -x_verkada_auth_api 'v2_sd78d9verkada-token' The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Cameras/Set-VerkadaCameraCloudBackupSettings.ps1 b/verkadaModule/Public/Cameras/Set-VerkadaCameraCloudBackupSettings.ps1 index 273b4bd..0437b86 100644 --- a/verkadaModule/Public/Cameras/Set-VerkadaCameraCloudBackupSettings.ps1 +++ b/verkadaModule/Public/Cameras/Set-VerkadaCameraCloudBackupSettings.ps1 @@ -15,7 +15,7 @@ function Set-VerkadaCameraCloudBackupSettings{ This will set the camera cwdfwfw-3f3-cwdf2-cameraId to use cloud backup with the submitted settings. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Set-VerkadaCameraCloudBackupSettings -enabled 1 -upload_timeslot '0,86400' -time_to_preserve '25200,68400' -days_to_preserve '1,1,1,1,1,1,1' -video_to_upload 'ALL' -video_quality 'STANDARD_QUALITY' -camera_id 'cwdfwfw-3f3-cwdf2-cameraId' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Set-VerkadaCameraCloudBackupSettings -enabled 1 -upload_timeslot '0,86400' -time_to_preserve '25200,68400' -days_to_preserve '1,1,1,1,1,1,1' -video_to_upload 'ALL' -video_quality 'STANDARD_QUALITY' -camera_id 'cwdfwfw-3f3-cwdf2-cameraId' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will set the camera cwdfwfw-3f3-cwdf2-cameraId to use cloud backup with the submitted settings. The token is submitted as a parameter in the call. .EXAMPLE diff --git a/verkadaModule/Public/Cameras/Set-VerkadaCameraLicensePlateOfInterest.ps1 b/verkadaModule/Public/Cameras/Set-VerkadaCameraLicensePlateOfInterest.ps1 index 48b72b0..4712fa2 100644 --- a/verkadaModule/Public/Cameras/Set-VerkadaCameraLicensePlateOfInterest.ps1 +++ b/verkadaModule/Public/Cameras/Set-VerkadaCameraLicensePlateOfInterest.ps1 @@ -23,7 +23,7 @@ function Set-VerkadaCameraLicensePlateOfInterest{ The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Set-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate Descriptionv2' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Set-VerkadaCameraLicensePlateOfInterest -license_plate 'ABC123' -description 'New License Plate Descriptionv2' -x_verkada_auth_api 'v2_sd78d9verkada-token' The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Common/Connect-Verkada.ps1 b/verkadaModule/Public/Common/Connect-Verkada.ps1 index 4715f75..287ee00 100644 --- a/verkadaModule/Public/Common/Connect-Verkada.ps1 +++ b/verkadaModule/Public/Common/Connect-Verkada.ps1 @@ -27,7 +27,7 @@ function Connect-Verkada This will authenticate user admin.user@contoso.com with a otp token and a secure string variable stored password([secureString]$yourPwd) and upon success store the org_id 7cd47706-f51b-4419-8675-3b9f0ce7c12d and the returned tokens. This will no longer work for OrgAdmins due to the MFA requirement. .EXAMPLE - Connect-Verkada -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'myapiKey-dcwdskjnlnlkj' -userName "admin.user@contoso.com" -Password + Connect-Verkada -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_api_key 'myapiKey-dcwdskjnlnlkj' -userName "admin.user@contoso.com" -Password This will store the org_id 7cd47706-f51b-4419-8675-3b9f0ce7c12d with the public API key myapiKey-dcwdskjnlnlkj and will authenticate user admin.user@contoso.com by prompting for the password(stored as a secure string) and storing the returned tokens. This will no longer work for OrgAdmins due to the MFA requirement. #> diff --git a/verkadaModule/Public/Core/Add-VerkadaCommandUser.ps1 b/verkadaModule/Public/Core/Add-VerkadaCommandUser.ps1 index bc0b21c..faf0b50 100644 --- a/verkadaModule/Public/Core/Add-VerkadaCommandUser.ps1 +++ b/verkadaModule/Public/Core/Add-VerkadaCommandUser.ps1 @@ -16,7 +16,7 @@ function Add-VerkadaCommandUser{ This will add the Command user with the name "New User". The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Add-VerkadaCommandUser -firstName 'New' -lastName 'User' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Add-VerkadaCommandUser -firstName 'New' -lastName 'User' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will add the Command user with the name "New User". The token is submitted as a parameter in the call. .EXAMPLE diff --git a/verkadaModule/Public/Core/Get-VerkadaCommandUser.ps1 b/verkadaModule/Public/Core/Get-VerkadaCommandUser.ps1 index f925a05..46d90b2 100644 --- a/verkadaModule/Public/Core/Get-VerkadaCommandUser.ps1 +++ b/verkadaModule/Public/Core/Get-VerkadaCommandUser.ps1 @@ -15,7 +15,7 @@ function Get-VerkadaCommandUser{ This will attempt to get the user details of a user with the userId of '3651fbcb-f8ba-4248-ad70-3f6512fd7b6c'. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Get-VerkadaCommandUser -externalId 'UserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Get-VerkadaCommandUser -externalId 'UserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will attempt to get the user details of a user with the externalId UserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Core/Remove-VerkadaCommandUser.ps1 b/verkadaModule/Public/Core/Remove-VerkadaCommandUser.ps1 index 467d1c9..f3d9fb4 100644 --- a/verkadaModule/Public/Core/Remove-VerkadaCommandUser.ps1 +++ b/verkadaModule/Public/Core/Remove-VerkadaCommandUser.ps1 @@ -15,7 +15,7 @@ function Remove-VerkadaCommandUser{ This will delete the Command user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaCommandUser -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaCommandUser -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will delete the Command user with externalId newUserUPN@contoso.com. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Core/Set-VerkadaCommandUser.ps1 b/verkadaModule/Public/Core/Set-VerkadaCommandUser.ps1 index 45370e7..05704d9 100644 --- a/verkadaModule/Public/Core/Set-VerkadaCommandUser.ps1 +++ b/verkadaModule/Public/Core/Set-VerkadaCommandUser.ps1 @@ -15,7 +15,7 @@ function Set-VerkadaCommandUser{ This will update the Command user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 with the name "New User". The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Set-VerkadaCommandUser -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -firstName 'New' -lastName 'User' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Set-VerkadaCommandUser -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -firstName 'New' -lastName 'User' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will update the Command user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 with the name "New User". The token is submitted as a parameter in the call. .EXAMPLE diff --git a/verkadaModule/Public/Guest/Read-VerkadaGuestSites.ps1 b/verkadaModule/Public/Guest/Read-VerkadaGuestSites.ps1 index 1b55669..da77f86 100644 --- a/verkadaModule/Public/Guest/Read-VerkadaGuestSites.ps1 +++ b/verkadaModule/Public/Guest/Read-VerkadaGuestSites.ps1 @@ -15,7 +15,7 @@ function Read-VerkadaGuestSites{ This will return all the Guest in an organization. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Read-VerkadaGuestSites -userId 'aefrfefb-3429-39ec-b042-userAC' -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a' -x_verkada_auth 'auth-token-uuid-dscsdc' -usr 'a099bfe6-34ff-4976-9d53-ac68342d2b60' + Read-VerkadaGuestSites -x_verkada_auth_api 'v2_sd78d9verkada-token' This will return all the Guest sites in an organization. The token will be populated from the cache created by Connect-Verkada. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Helix/Add-VerkadaHelixEvent.ps1 b/verkadaModule/Public/Helix/Add-VerkadaHelixEvent.ps1 index 82ab08b..6452251 100644 --- a/verkadaModule/Public/Helix/Add-VerkadaHelixEvent.ps1 +++ b/verkadaModule/Public/Helix/Add-VerkadaHelixEvent.ps1 @@ -15,7 +15,7 @@ function Add-VerkadaHelixEvent{ This will add a new helix event for the current time for the sepcified camera, event ID, and submitted attributes. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Add-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -attributes $attributes -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Add-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -attributes $attributes -x_verkada_auth_api 'v2_sd78d9verkada-token' This will add a new helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, event ID, and submitted attributes. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Helix/Find-VerkadaHelixEvent.ps1 b/verkadaModule/Public/Helix/Find-VerkadaHelixEvent.ps1 index e3cd0c9..674d364 100644 --- a/verkadaModule/Public/Helix/Find-VerkadaHelixEvent.ps1 +++ b/verkadaModule/Public/Helix/Find-VerkadaHelixEvent.ps1 @@ -22,7 +22,7 @@ function Find-VerkadaHelixEvent{ This will get the helix events for camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Find-VerkadaHelixEvent -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -startTimeStamp '1/1/2025 08:35:00 -06' -endTimeStamp '1/7/2025 17:00:00 -06' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Find-VerkadaHelixEvent -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -startTimeStamp '1/1/2025 08:35:00 -06' -endTimeStamp '1/7/2025 17:00:00 -06' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will find the helix events for from Jan 1, 2025 at 8:35 AM CST to Jan 7, 2025 at 5:00 APM CST for the sepcified event ID. The token is submitted as parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Helix/Get-VerkadaHelixEvent.ps1 b/verkadaModule/Public/Helix/Get-VerkadaHelixEvent.ps1 index c4a3fc0..0beb83c 100644 --- a/verkadaModule/Public/Helix/Get-VerkadaHelixEvent.ps1 +++ b/verkadaModule/Public/Helix/Get-VerkadaHelixEvent.ps1 @@ -15,7 +15,7 @@ function Get-VerkadaHelixEvent{ This will get the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, and event ID. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Get-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Get-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will get the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, and event ID. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Helix/Remove-VerkadaHelixEvent.ps1 b/verkadaModule/Public/Helix/Remove-VerkadaHelixEvent.ps1 index 76cb67d..109eb66 100644 --- a/verkadaModule/Public/Helix/Remove-VerkadaHelixEvent.ps1 +++ b/verkadaModule/Public/Helix/Remove-VerkadaHelixEvent.ps1 @@ -15,7 +15,7 @@ function Remove-VerkadaHelixEvent{ This will delete the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, and event ID. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Remove-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Remove-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -x_verkada_auth_api 'v2_sd78d9verkada-token' This will delete the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, and event ID. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Helix/Set-VerkadaHelixEvent.ps1 b/verkadaModule/Public/Helix/Set-VerkadaHelixEvent.ps1 index 0d31ae1..104893a 100644 --- a/verkadaModule/Public/Helix/Set-VerkadaHelixEvent.ps1 +++ b/verkadaModule/Public/Helix/Set-VerkadaHelixEvent.ps1 @@ -15,7 +15,7 @@ function Set-VerkadaHelixEvent{ This will get the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, event ID, and submitted attributes. The token will be populated from the cache created by Connect-Verkada. .EXAMPLE - Get-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -attributes $attributes -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' + Get-VerkadaHelixEvent -camera_id 6b8731d7-d991-4206-ba71-b5446fa617fc -event_type_uid cf918b16-26cd-4c01-a672-5a91b79311e1 -timeStamp '1/1/2025 08:35:00 -06' -attributes $attributes -x_verkada_auth_api 'v2_sd78d9verkada-token' This will get the helix event for Jan 1, 2025 at 8:35 AM CST for the sepcified camera, event ID, and submitted attributes. The token is submitted as a parameter in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/Public/Legacy/Cameras/Get-VerkadaCameraConfig.ps1 b/verkadaModule/Public/Legacy/Cameras/Get-VerkadaCameraConfig.ps1 index 9bdeca5..635c6aa 100644 --- a/verkadaModule/Public/Legacy/Cameras/Get-VerkadaCameraConfig.ps1 +++ b/verkadaModule/Public/Legacy/Cameras/Get-VerkadaCameraConfig.ps1 @@ -23,7 +23,7 @@ function Get-VerkadaCameraConfig{ This will retieve the config information for all of the cameraId's present in the given CSV. The org_id and tokens will be populated from the cached created by Connect-Verkada. .EXAMPLE - Get-VerkadaCameraConfig -cameraId '6fbdcd72-a2ec-4016-9c6f-21553a42c998' -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token' -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a' -x_verkada_auth 'auth-token-uuid-dscsdc' + Get-VerkadaCameraConfig -cameraId '6fbdcd72-a2ec-4016-9c6f-21553a42c998' -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'v2_sd78d9verkada-token' -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a' -x_verkada_auth 'auth-token-uuid-dscsdc' This will retieve the config information for the camera with Id 6fbdcd72-a2ec-4016-9c6f-21553a42c998. The org_id and tokens are submitted as parameters in the call. #> [CmdletBinding(PositionalBinding = $true)] diff --git a/verkadaModule/verkadaModule.psd1 b/verkadaModule/verkadaModule.psd1 index c8a812c..1d8ddd7 100644 --- a/verkadaModule/verkadaModule.psd1 +++ b/verkadaModule/verkadaModule.psd1 @@ -3,7 +3,7 @@ # # Generated by: Verkada SE Community # -# Generated on: 12/10/2025 +# Generated on: 04/27/2026 # @{ @@ -12,7 +12,7 @@ RootModule = 'verkadaModule.psm1' # Version number of this module. -ModuleVersion = '0.10.3' +ModuleVersion = '0.10.4' # Supported PSEditions CompatiblePSEditions = 'Desktop', 'Core' @@ -72,8 +72,10 @@ PowerShellVersion = '6.1' FunctionsToExport = 'Add-VerkadaAccessGroup', 'Add-VerkadaAccessUserCard', 'Add-VerkadaAccessUserLicensePlate', 'Add-VerkadaAccessUserMfaCode', 'Disable-VerkadaAccessUserCard', + 'Disable-VerkadaAccessUserFaceUnlock', 'Disable-VerkadaAccessUserLicensePlate', 'Enable-VerkadaAccessUserCard', + 'Enable-VerkadaAccessUserFaceUnlock', 'Enable-VerkadaAccessUserLicensePlate', 'Get-VerkadaAccessEvents', 'Get-VerkadaAccessGroup', 'Get-VerkadaAccessUser', 'Get-VerkadaAccessUserProfilePicture', 'Read-VerkadaAccessGroups', @@ -85,9 +87,11 @@ FunctionsToExport = 'Add-VerkadaAccessGroup', 'Add-VerkadaAccessUserCard', 'Remove-VerkadaAccessUserMfaCode', 'Remove-VerkadaAccessUserProfilePicture', 'Remove-VerkadaAccessUserRemoteUnlock', - 'Send-VerkadaAccessPassInvite', 'Set-VerkadaAccessUserBleUnlock', - 'Set-VerkadaAccessUserEndDate', 'Set-VerkadaAccessUserEntryCode', - 'Set-VerkadaAccessUserGroup', 'Set-VerkadaAccessUserProfilePicture', + 'Send-VerkadaAccessPassInvite', + 'Send-VerkadaAccessUserFaceUnlockInvite', + 'Set-VerkadaAccessUserBleUnlock', 'Set-VerkadaAccessUserEndDate', + 'Set-VerkadaAccessUserEntryCode', 'Set-VerkadaAccessUserGroup', + 'Set-VerkadaAccessUserProfilePicture', 'Set-VerkadaAccessUserRemoteUnlock', 'Set-VerkadaAccessUserStartDate', 'Unlock-VerkadaAccessDoor', 'Add-VerkadaCameraLicensePlateOfInterest', @@ -139,8 +143,10 @@ AliasesToExport = 'a-VrkdaAcGrp', 'Add-VrkdaAcGrp', 'a-VrkdaAcUsrCrd', 'Add-VerkadaLicensePlateOfInterest', 'Add-VerkadaLPoI', 'Add-VrkdaLPoI', 'a-VrkdaCmdUsr', 'Add-VrkdaCmdUsr', 'a-VrkdaHlxEvt', 'Add-VrkdaHlxEvt', 'a-VrkdaWrkEmp', 'Add-VrkdaWrkEmp', - 'd-VrkdaAcUsrCrd', 'Disable-VrkdaAcUsrCrd', 'd-VrkdaAcUsrLPR', + 'd-VrkdaAcUsrCrd', 'Disable-VrkdaAcUsrCrd', 'd-VrkdaAcUsrFaceUnlk', + 'Disable-VrkdaAcUsrFaceUnlk', 'd-VrkdaAcUsrLPR', 'Disable-VrkdaAcUsrLPR', 'e-VrkdaAcUsrCrd', 'Enable-VrkdaAcUsrCrd', + 'e-VrkdaAcUsrFaceUnlk', 'Enable-VrkdaAcUsrFaceUnlk', 'e-VrkdaAcUsrLPR', 'Enable-VrkdaAcUsrLPR', 'fd-VrkdaHlxEvt', 'Find-VrkdaHlxEvt', 'otp', 'Get-VrkdaAcEvnts', 'gt-VrkdaAcEvnts', 'Get-VrkdaAcGrp', 'gt-VrkdaAcGrp', 'Get-VrkdaAcUsr', 'gt-VrkdaAcUsr', @@ -168,7 +174,8 @@ AliasesToExport = 'a-VrkdaAcGrp', 'Add-VrkdaAcGrp', 'a-VrkdaAcUsrCrd', 'rm-VrkdaCmdUsr', 'Remove-VrkdaHlxEvt', 'rm-VrkdaHlxEvt', 'Remove-VrkdaWrkEmp', 'rm-VrkdaWrkEmp', 'sd-VrkdaAcPssInv', 'sd-VrkdaPssInv', 'Send-VerkadaPassInvite', 'Send-VrkdaAcPssInv', - 'Send-VrkdaPssInv', 'Set-VrkdaAcDrNm', 'st-VrkdaAcDrNm', + 'Send-VrkdaPssInv', 'sd-VrkdaAcUsrUsrFaceInv', + 'Send-VrkdaAcUsrUsrFaceInv', 'Set-VrkdaAcDrNm', 'st-VrkdaAcDrNm', 's-VrkdAcDrSchOvrd', 'Set-VrkdAcDrSchOvrd', 'Set-VrkdaAcUsrBtUnlk', 'st-VrkdaAcUsrBtUnlk', 'Set-VrkdaAcUsrEndDt', 'st-VrkdaAcUsrEndDt', 'Set-VrkdaAcUsrEntryCo', 'st-VrkdaAcUsrEntryCo', 'Set-VrkdaAcUsrGrp',