From 51dc75336cafd974c3bc3d441430eaf3fc76205a Mon Sep 17 00:00:00 2001 From: bepsoccer <26012546+bepsoccer@users.noreply.github.com> Date: Tue, 13 May 2025 14:53:48 +0000 Subject: [PATCH 1/2] Bumping release to 0.9.2 --- .../Invoke-VerkadaFormCall.md | 46 ++++++++++- .../Set-VerkadaAccessUserProfilePicture.md | 76 +++++++++++++------ verkadaModule/verkadaModule.psd1 | 4 +- 3 files changed, 97 insertions(+), 29 deletions(-) diff --git a/docs/function-documentation/Invoke-VerkadaFormCall.md b/docs/function-documentation/Invoke-VerkadaFormCall.md index 050604b..798e019 100644 --- a/docs/function-documentation/Invoke-VerkadaFormCall.md +++ b/docs/function-documentation/Invoke-VerkadaFormCall.md @@ -12,9 +12,17 @@ Used to build an Invoke-RestMethod call for Verkada's private API enpoints that ## SYNTAX +### Default (Default) ``` -Invoke-VerkadaFormCall [-url] [-org_id] [-form_params] [-method ] - -x_verkada_token -x_verkada_auth [-ProgressAction ] [] +Invoke-VerkadaFormCall [-url] [-org_id] [-form_params] [-query_params ] + [-method ] [-x_verkada_auth_api ] [-ProgressAction ] [] +``` + +### UnPwd +``` +Invoke-VerkadaFormCall [-url] [-org_id] [-form_params] [-query_params ] + [-method ] -x_verkada_token -x_verkada_auth [-ProgressAction ] + [] ``` ## DESCRIPTION @@ -76,6 +84,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -query_params +Object containing the query parameters need that will be put into the query string of the uri + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -method HTTP method required @@ -96,7 +119,7 @@ The Verkada(CSRF) token of the user running the command ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UnPwd Aliases: Required: True @@ -111,7 +134,7 @@ The Verkada Auth(session auth) token of the user running the command ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: UnPwd Aliases: Required: True @@ -121,6 +144,21 @@ Accept pipeline input: False 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: Default +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ProgressAction {{ Fill ProgressAction Description }} diff --git a/docs/function-documentation/Set-VerkadaAccessUserProfilePicture.md b/docs/function-documentation/Set-VerkadaAccessUserProfilePicture.md index 6398b3c..51d1865 100644 --- a/docs/function-documentation/Set-VerkadaAccessUserProfilePicture.md +++ b/docs/function-documentation/Set-VerkadaAccessUserProfilePicture.md @@ -8,20 +8,20 @@ schema: 2.0.0 # Set-VerkadaAccessUserProfilePicture ## SYNOPSIS -Adds/replaces an Access user's profile picture in an organization. +Adds/replaces an Access user's profile picture in an organization using https://apidocs.verkada.com/reference/putprofilephotoviewv1 ## SYNTAX ``` -Set-VerkadaAccessUserProfilePicture [[-userId] ] [[-imagePath] ] [[-org_id] ] - [[-x_verkada_token] ] [[-x_verkada_auth] ] [[-usr] ] - [-ProgressAction ] [] +Set-VerkadaAccessUserProfilePicture [[-userId] ] [[-externalId] ] [[-imagePath] ] + [[-overwrite] ] [[-org_id] ] [[-x_verkada_auth_api] ] [[-region] ] + [-errorsToFile] [-ProgressAction ] [] ``` ## DESCRIPTION -This will set the Access user's, specified by the userId, profile picture. +This will set the Access user's, specified by the user_Id or external_ID, profile picture. This must be a png or jpeg/jpg format image. -The org_id and reqired tokens can be directly submitted as parameters, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. +The org_id and reqired token can be directly submitted as parameters, but is much easier to use Connect-Verkada to cache this information ahead of time and for subsequent commands. ## EXAMPLES @@ -33,8 +33,8 @@ This sets the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 to us ### EXAMPLE 2 ``` -Set-VerkadaAccessUserProfilePicture -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -imagePath './myPicture.png' -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' -This sets the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 to use the picture specified at path ./myPicture.png. The org_id and tokens are submitted as parameters in the call. +Set-VerkadaAccessUserProfilePicture -externalId 'newUserUPN@contoso.com' -imagePath './myPicture.png' -overwrite $true -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-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 org_id and tokens are submitted as parameters in the call. ``` ## PARAMETERS @@ -54,6 +54,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -externalId +unique identifier managed externally provided by the consumer + +```yaml +Type: String +Parameter Sets: (All) +Aliases: external_id + +Required: False +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -imagePath This is the path the image will be uploaded from @@ -63,12 +78,27 @@ Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: 3 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: 4 +Default value: False +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -org_id The UUID of the organization the user belongs to @@ -78,14 +108,14 @@ Parameter Sets: (All) Aliases: Required: False -Position: 3 +Position: 5 Default value: $Global:verkadaConnection.org_id Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -x_verkada_token -The Verkada(CSRF) token of the user running the command +### -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 @@ -93,14 +123,14 @@ Parameter Sets: (All) Aliases: Required: False -Position: 4 -Default value: $Global:verkadaConnection.csrfToken +Position: 6 +Default value: $Global:verkadaConnection.x_verkada_auth_api Accept pipeline input: False Accept wildcard characters: False ``` -### -x_verkada_auth -The Verkada Auth(session auth) token of the user running the command +### -region +The region of the public API to be used ```yaml Type: String @@ -108,23 +138,23 @@ Parameter Sets: (All) Aliases: Required: False -Position: 5 -Default value: $Global:verkadaConnection.userToken +Position: 7 +Default value: Api Accept pipeline input: False Accept wildcard characters: False ``` -### -usr -The UUID of the user account making the request +### -errorsToFile +Switch to write errors to file ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 6 -Default value: $Global:verkadaConnection.usr +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/verkadaModule/verkadaModule.psd1 b/verkadaModule/verkadaModule.psd1 index afabe16..698e0e1 100644 --- a/verkadaModule/verkadaModule.psd1 +++ b/verkadaModule/verkadaModule.psd1 @@ -3,7 +3,7 @@ # # Generated by: Verkada SE Community # -# Generated on: 05/12/2025 +# Generated on: 05/13/2025 # @{ @@ -12,7 +12,7 @@ RootModule = 'verkadaModule.psm1' # Version number of this module. -ModuleVersion = '0.9.1' +ModuleVersion = '0.9.2' # Supported PSEditions CompatiblePSEditions = 'Desktop', 'Core' From 8a601aea355c08704aedd768c1529a4e8d0e4ced Mon Sep 17 00:00:00 2001 From: Brad Parker Date: Tue, 13 May 2025 10:03:41 -0500 Subject: [PATCH 2/2] hopefully fix version control --- .github/workflows/versioning.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/versioning.yml b/.github/workflows/versioning.yml index bb8ca39..fdb8997 100644 --- a/.github/workflows/versioning.yml +++ b/.github/workflows/versioning.yml @@ -37,6 +37,7 @@ jobs: uses: stefanzweifel/git-auto-commit-action@v5 with: commit_message: Bumping release to ${{ steps.buildUpdate.outputs.v }} + branch: release Minor: if: startsWith(github.head_ref, 'minor/') && github.event.pull_request.merged == true outputs: