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
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
---
external help file: verkadaModule-help.xml
Module Name: verkadaModule
online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaPassInvite.md
online version: https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaAccessPassInvite.md
schema: 2.0.0
---

# Send-VerkadaPassInvite
# Send-VerkadaAccessPassInvite

## SYNOPSIS
Send a Verkada Pass email invited to an Access user in an organization using https://apidocs.verkada.com/reference/postsendpassappinviteviewv1

## SYNTAX

```
Send-VerkadaPassInvite [[-userId] <String>] [[-externalId] <String>] [-activateBLE]
Send-VerkadaAccessPassInvite [[-userId] <String>] [[-externalId] <String>] [-activateBLE]
[[-x_verkada_auth_api] <String>] [[-region] <String>] [-errorsToFile] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```
Expand All @@ -26,19 +26,19 @@ The reqired token can be directly submitted as a parameter, but is much easier t

### EXAMPLE 1
```
Send-VerkadaPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3'
Send-VerkadaAccessPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3'
This will send an email invite to an Access user with userId 801c9551-b04c-4293-84ad-b0a6aa0588b3. The token will be populated from the cache created by Connect-Verkada.
```

### EXAMPLE 2
```
Send-VerkadaPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -activateBLE
Send-VerkadaAccessPassInvite -userId '801c9551-b04c-4293-84ad-b0a6aa0588b3' -activateBLE
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 3
```
Send-VerkadaPassInvite -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token'
Send-VerkadaAccessPassInvite -externalId 'newUserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-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.
```

Expand Down Expand Up @@ -160,5 +160,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## RELATED LINKS

[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaPassInvite.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaPassInvite.md)
[https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaAccessPassInvite.md](https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Send-VerkadaAccessPassInvite.md)

139 changes: 0 additions & 139 deletions docs/function-documentation/Add-VerkadaLicensePlateOfInterest.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# Get-VerkadaCommandUser

## SYNOPSIS
using https://apidocs.verkada.com/reference/getuserviewv1
Gets a Command user using https://apidocs.verkada.com/reference/getuserviewv1

## SYNTAX

Expand Down
149 changes: 0 additions & 149 deletions docs/function-documentation/Get-VerkadaCloudBackupSettings.md

This file was deleted.

Loading