| external help file | verkadaModule-help.xml |
|---|---|
| Module Name | verkadaModule |
| online version | https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Remove-VerkadaWorkplaceEmployee.md |
| schema | 2.0.0 |
Removes a Verkada Workplace employee from an org and/or a specific site.
Remove-VerkadaWorkplaceEmployee [[-hostId] <String>] [[-siteId] <String>] [[-siteName] <String>]
[[-org_id] <String>] [[-x_verkada_token] <String>] [[-x_verkada_auth] <String>] [[-usr] <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Used to remove a Verkada Workplace employee from the root org and/or specific sites. Specificying the siteId or siteName will remove the employee from that site. These paramteres are mutally exclusive. Omitting siteId or siteName will remove the employee from the root org. 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.
Remove-VerkadaWorkplaceEmployee -hostId 8b6e9c59-ffff-4f89-9367-7e6786346f29
This will remove the Workplace employee with the hostId '8b6e9c59-ffff-4f89-9367-7e6786346f29' from the root organization. The org_id and tokens will be populated from the cached created by Connect-Verkada.
Remove-VerkadaWorkplaceEmployee -hostId 8b6e9c59-ffff-4f89-9367-7e6786346f29 -siteId '21efb7f-8329-4886-a89d-d2cc482b01d0'
This will remove the Workplace employee with the hostId '8b6e9c59-ffff-4f89-9367-7e6786346f29' from the site with the id 'c21efb7f-8329-4886-a89d-d2cc482b01d0' from the organization. The org_id and tokens will be populated from the cached created by Connect-Verkada.
Get-VerkadaWorkplaceEmployee -siteName 'My Guest Site' -email "new.user@contoso.com" | Remove-VerkadaWorkplaceEmployee
This will remove the Workplace employee with the email address new.user@contoso.com from the site named 'My Guest Site'from the organization. The org_id and tokens will be populated from the cached created by Connect-Verkada.
Remove-VerkadaWorkplaceEmployee -hostId 8b6e9c59-ffff-4f89-9367-7e6786346f29 -siteName 'My Guest Site' -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 will remove the Workplace employee with the hostId '8b6e9c59-ffff-4f89-9367-7e6786346f29' from the site named 'My Guest Site'from the organization. The org_id and tokens are submitted as parameters in the call.
The UUID of the employee
Type: String
Parameter Sets: (All)
Aliases: employeeId
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe UUID of the site
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe siteName if siteId is unknown
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe UUID of the organization the user belongs to
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: $Global:verkadaConnection.org_id
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe Verkada(CSRF) token of the user running the command
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: $Global:verkadaConnection.csrfToken
Accept pipeline input: False
Accept wildcard characters: FalseThe Verkada Auth(session auth) token of the user running the command
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: $Global:verkadaConnection.userToken
Accept pipeline input: False
Accept wildcard characters: FalseThe UUID of the user account making the request
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: $Global:verkadaConnection.usr
Accept pipeline input: False
Accept wildcard characters: False{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.