Skip to content

Commit caca9ff

Browse files
bepsoccergithub-actions[bot]
bepsoccer
authored and
github-actions[bot]
committed
Bumping release to 0.7.2
1 parent 6642d06 commit caca9ff

4 files changed

Lines changed: 123 additions & 7 deletions

File tree

‎docs/function-documentation/Connect-Verkada.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,20 +43,26 @@ This will store the org_id 7cd47706-f51b-4419-8675-3b9f0ce7c12d with the public
4343

4444
### EXAMPLE 2
4545
```
46-
Connect-Verkada '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -userName "admin.user@contoso.com" -Password
47-
This will authenticate user admin.user@contoso.com by prompting for the password(stored as a secure string) and upon success store the org_id 7cd47706-f51b-4419-8675-3b9f0ce7c12d and the returned tokens.
46+
Connect-Verkada '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -userName "admin.user@contoso.com" -otp (Get-Otp (Get-Secret -Name myVerkadaOtp -AsPlainText)) -MyPwd (Get-Secret -Name myVerkadaPassword) -x_api_key 'myapiKey-dcwdskjnlnlkj'
47+
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 also store the org_id 7cd47706-f51b-4419-8675-3b9f0ce7c12d with the public API key myapiKey-dcwdskjnlnlkj
4848
```
4949

5050
### EXAMPLE 3
5151
```
52-
Connect-Verkada '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -userName "admin.user@contoso.com" -otp '123456' -MyPwd $yourPwd(seure string)
53-
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.
52+
Connect-Verkada '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -userName "admin.user@contoso.com" -Password
53+
This will authenticate user admin.user@contoso.com by prompting for the password(stored as a secure string) 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.
5454
```
5555

5656
### EXAMPLE 4
5757
```
58+
Connect-Verkada '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -userName "admin.user@contoso.com" -otp '123456' -MyPwd $yourPwd(seure string)
59+
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.
60+
```
61+
62+
### EXAMPLE 5
63+
```
5864
Connect-Verkada '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_api_key 'myapiKey-dcwdskjnlnlkj' -userName "admin.user@contoso.com" -Password
59-
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.
65+
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.
6066
```
6167

6268
## PARAMETERS

‎docs/function-documentation/Get-Otp.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
external help file: verkadaModule-help.xml
3+
Module Name: verkadaModule
4+
online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Get-Otp.md
5+
schema: 2.0.0
6+
---
7+
8+
# Get-Otp
9+
10+
## SYNOPSIS
11+
Time-base One-Time Password Algorithm (RFC 6238)
12+
13+
## SYNTAX
14+
15+
```
16+
Get-Otp [-SECRET] <Object> [[-LENGTH] <Object>] [[-WINDOW] <Object>] [-ProgressAction <ActionPreference>]
17+
[<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
This is an implementation of the RFC 6238 Time-Based One-Time Password Algorithm draft based upon the HMAC-based One-Time Password (HOTP) algorithm (RFC 4226).
22+
This is a time based variant of the HOTP algorithm providing short-lived OTP values.
23+
24+
## EXAMPLES
25+
26+
### EXAMPLE 1
27+
```
28+
Get-Otp MySecretTotpKey
29+
```
30+
31+
## PARAMETERS
32+
33+
### -SECRET
34+
{{ Fill SECRET Description }}
35+
36+
```yaml
37+
Type: Object
38+
Parameter Sets: (All)
39+
Aliases:
40+
41+
Required: True
42+
Position: 1
43+
Default value: None
44+
Accept pipeline input: False
45+
Accept wildcard characters: False
46+
```
47+
48+
### -LENGTH
49+
{{ Fill LENGTH Description }}
50+
51+
```yaml
52+
Type: Object
53+
Parameter Sets: (All)
54+
Aliases:
55+
56+
Required: False
57+
Position: 2
58+
Default value: 6
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### -WINDOW
64+
{{ Fill WINDOW Description }}
65+
66+
```yaml
67+
Type: Object
68+
Parameter Sets: (All)
69+
Aliases:
70+
71+
Required: False
72+
Position: 3
73+
Default value: 30
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
78+
### -ProgressAction
79+
{{ Fill ProgressAction Description }}
80+
81+
```yaml
82+
Type: ActionPreference
83+
Parameter Sets: (All)
84+
Aliases: proga
85+
86+
Required: False
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
93+
### CommonParameters
94+
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).
95+
96+
## INPUTS
97+
98+
## OUTPUTS
99+
100+
## NOTES
101+
Version: 1.0
102+
Author: Jon Friesen
103+
Creation Date: May 7, 2015
104+
Purpose/Change: Provide an easy way of generating OTPs
105+
106+
## RELATED LINKS
107+
108+
[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Get-Otp.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Get-Otp.md)
109+

‎docs/reference.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
* [Export-VerkadaAccessUserProfilePicture](function-documentation/Export-VerkadaAccessUserProfilePicture.md)
2323
* [Find-VerkadaCommandUser](function-documentation/Find-VerkadaCommandUser.md)
2424
* [Find-VerkadaUserId](function-documentation/Find-VerkadaUserId.md)
25+
* [Get-Otp](function-documentation/Get-Otp.md)
2526
* [Get-VerkadaAccessCredential](function-documentation/Get-VerkadaAccessCredential.md)
2627
* [Get-VerkadaAccessDoorConfigReport](function-documentation/Get-VerkadaAccessDoorConfigReport.md)
2728
* [Get-VerkadaAccessDoors](function-documentation/Get-VerkadaAccessDoors.md)

‎verkadaModule/verkadaModule.psd1‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: Verkada SE Community
55
#
6-
# Generated on: 6/27/2024
6+
# Generated on: 06/28/2024
77
#
88

99
@{
@@ -12,7 +12,7 @@
1212
RootModule = 'verkadaModule.psm1'
1313

1414
# Version number of this module.
15-
ModuleVersion = '0.7.1'
15+
ModuleVersion = '0.7.2'
1616

1717
# Supported PSEditions
1818
CompatiblePSEditions = 'Desktop', 'Core'

0 commit comments

Comments
 (0)