Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 8 additions & 23 deletions docs/function-documentation/Add-VerkadaAccessGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,28 @@ Creates an Access group in an organization using https://apidocs.verkada.com/ref
## SYNTAX

```
Add-VerkadaAccessGroup [[-name] <String>] [[-org_id] <String>] [[-x_verkada_auth_api] <String>]
[[-region] <String>] [-errorsToFile] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Add-VerkadaAccessGroup [[-name] <String>] [[-x_verkada_auth_api] <String>] [[-region] <String>] [-errorsToFile]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Create an access group within the given organization using the given name.
The name of the access group must be unique within the organization.
This returns the Access Group Metadata Object for the created Access Group.
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.
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
```
Add-VerkadaAccessGroup -name 'Newgroup'
This will add the access group with the name "NewGroup". The org_id and tokens will be populated from the cached created by Connect-Verkada.
This will add the access group with the name "NewGroup". The token will be populated from the cache created by Connect-Verkada.
```

### EXAMPLE 2
```
Add-VerkadaAccessGroup -name 'NewGroup' -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token'
This will add the access group with the name "NewGroup". The org_id and tokens are submitted as parameters in the call.
Add-VerkadaAccessGroup -name 'NewGroup' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token'
This will add the access group with the name "NewGroup". The token is submitted as a parameter in the call.
```

## PARAMETERS
Expand All @@ -54,21 +54,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -org_id
The UUID of the organization the user belongs to

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: $Global:verkadaConnection.org_id
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

Expand All @@ -78,7 +63,7 @@ Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Position: 2
Default value: $Global:verkadaConnection.x_verkada_auth_api
Accept pipeline input: False
Accept wildcard characters: False
Expand All @@ -93,7 +78,7 @@ Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Position: 3
Default value: Api
Accept pipeline input: False
Accept wildcard characters: False
Expand Down
38 changes: 11 additions & 27 deletions docs/function-documentation/Add-VerkadaAccessUserCard.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,50 +15,49 @@ Creates and adds an Access credential to an Access user in an organization using
### cardNumber (Default)
```
Add-VerkadaAccessUserCard [-userId <String>] [-externalId <String>] -cardType <String> -cardNumber <String>
[-facilityCode <String>] [-active <Boolean>] [-org_id <String>] [-x_verkada_auth_api <String>]
[-region <String>] [-errorsToFile] [-ProgressAction <ActionPreference>] [<CommonParameters>]
[-facilityCode <String>] [-active <Boolean>] [-x_verkada_auth_api <String>] [-region <String>] [-errorsToFile]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### cardNumberHex
```
Add-VerkadaAccessUserCard [-userId <String>] [-externalId <String>] -cardType <String> -cardNumberHex <String>
[-facilityCode <String>] [-active <Boolean>] [-org_id <String>] [-x_verkada_auth_api <String>]
[-region <String>] [-errorsToFile] [-ProgressAction <ActionPreference>] [<CommonParameters>]
[-facilityCode <String>] [-active <Boolean>] [-x_verkada_auth_api <String>] [-region <String>] [-errorsToFile]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### cardNumberBase36
```
Add-VerkadaAccessUserCard [-userId <String>] [-externalId <String>] -cardType <String>
-cardNumberBase36 <String> [-facilityCode <String>] [-active <Boolean>] [-org_id <String>]
[-x_verkada_auth_api <String>] [-region <String>] [-errorsToFile] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
-cardNumberBase36 <String> [-facilityCode <String>] [-active <Boolean>] [-x_verkada_auth_api <String>]
[-region <String>] [-errorsToFile] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Create and add an access card for a specified user_id or external_id and org_id.
Card object will be passed in the body of the request as a json.
We require facility code and card number OR card_number_hex OR card_number_base36.
The successful repsonse will be the created credential information.
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.
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
```
Add-VerkadaAccessUserCard -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -type 'HID' -facilityCode 111 -cardNumber 55555
This will add a badge in the HID format with facility code 111 and card number 55555 to the user specified. The org_id and tokens will be populated from the cached created by Connect-Verkada.
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 2
```
Add-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -type 'HID' -facilityCode 111 -cardNumber 55555 -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token'
This will add an Access credential in the HID format with facility code 111 and card number 55555 to the user specified. The org_id and tokens are submitted as parameters in the call.
Add-VerkadaAccessUserCard -externalId 'newUserUPN@contoso.com' -type 'HID' -facilityCode 111 -cardNumber 55555 -x_verkada_auth_api 'sd78ds-uuid-of-verkada-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 3
```
Import-Csv ./myUserBadges.csv | Add-VerkadaAccessUserCard
This will add an Access credential for every row in the csv file which contains userId, type, cardNumber(or cardNumberHex or cardNumberBase36), and facilityCode(optional). The org_id and tokens will be populated from the cached created by Connect-Verkada.
This will add an Access credential for every row in the csv file which contains userId, type, cardNumber(or cardNumberHex or cardNumberBase36), and facilityCode(optional). The token will be populated from the cache created by Connect-Verkada.
```

## PARAMETERS
Expand Down Expand Up @@ -184,21 +183,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -org_id
The UUID of the organization the user belongs to

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $Global:verkadaConnection.org_id
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

Expand Down
32 changes: 8 additions & 24 deletions docs/function-documentation/Add-VerkadaAccessUserLicensePlate.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,29 @@ Adds a license plate credential to an Aceess user in an organization using https

```
Add-VerkadaAccessUserLicensePlate [[-userId] <String>] [[-externalId] <String>]
[[-licensePlateNumber] <String>] [[-name] <String>] [[-active] <Boolean>] [[-org_id] <String>]
[[-x_verkada_auth_api] <String>] [[-region] <String>] [-errorsToFile] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
[[-licensePlateNumber] <String>] [[-name] <String>] [[-active] <Boolean>] [[-x_verkada_auth_api] <String>]
[[-region] <String>] [-errorsToFile] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Add a license plate credential to a user given a specified user_id or external_id and org_id.
License plate object will be passed in the body of the request as a json.
We require a string of 6 alphanumeric values.
The License Plate Object is returned.
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.
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
```
Add-VerkadaAccessUserLicensePlate -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -licensePlateNumber 'ABC123'
This will add the license plate ABC123 to the Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3 as a credential. The org_id and tokens will be populated from the cached created by Connect-Verkada.
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 2
```
Add-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -name 'Users License Plate' -active $true -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a'
This will add the license plate ABC123 to the Access user with externalId newUserUPN@contoso.com as a credential and mark it active. The org_id and tokens are submitted as parameters in the call.
Add-VerkadaAccessUserLicensePlate -externalId 'newUserUPN@contoso.com' -licensePlateNumber 'ABC123' -name 'Users License Plate' -active $true -x_verkada_token 'a366ef47-2c20-4d35-a90a-10fd2aee113a'
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.
```

## PARAMETERS
Expand Down Expand Up @@ -118,21 +117,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -org_id
The UUID of the organization the user belongs to

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: $Global:verkadaConnection.org_id
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

Expand All @@ -142,7 +126,7 @@ Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Position: 6
Default value: $Global:verkadaConnection.x_verkada_auth_api
Accept pipeline input: False
Accept wildcard characters: False
Expand All @@ -157,7 +141,7 @@ Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Position: 7
Default value: Api
Accept pipeline input: False
Accept wildcard characters: False
Expand Down
31 changes: 8 additions & 23 deletions docs/function-documentation/Add-VerkadaAccessUserMfaCode.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,27 @@ Adds a mfa code credential to a user using https://apidocs.verkada.com/reference

```
Add-VerkadaAccessUserMfaCode [[-userId] <String>] [[-externalId] <String>] [[-mfaCode] <String>]
[[-org_id] <String>] [[-x_verkada_auth_api] <String>] [[-region] <String>] [-errorsToFile]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
[[-x_verkada_auth_api] <String>] [[-region] <String>] [-errorsToFile] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Adds a mfa code credential to a user given a specified user_id or external_id and org_id.
MFA code object will be passed in the body of the request as a json.
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.
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
```
Add-VerkadaAccessUserMfaCode -mfaCode '9567' -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3'
This adds the MFA code 9567 to the Access user's profile with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The org_id and token will be populated from the cached created by Connect-Verkada.
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 2
```
Add-VerkadaAccessUserMfaCode -mfaCode '9567' -externalId 'newUserUPN@contoso.com' -org_id '7cd47706-f51b-4419-8675-3b9f0ce7c12d' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token'
This adds the MFA code 9567 to the Access user's profile with externalId newUserUPN@contoso.com. The org_id and token are submitted as parameters in the call.
Add-VerkadaAccessUserMfaCode -mfaCode '9567' -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-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.
```

## PARAMETERS
Expand Down Expand Up @@ -84,21 +84,6 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -org_id
The UUID of the organization the user belongs to

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: $Global:verkadaConnection.org_id
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

Expand All @@ -108,7 +93,7 @@ Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Position: 4
Default value: $Global:verkadaConnection.x_verkada_auth_api
Accept pipeline input: False
Accept wildcard characters: False
Expand All @@ -123,7 +108,7 @@ Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Position: 5
Default value: Api
Accept pipeline input: False
Accept wildcard characters: False
Expand Down
Loading