| external help file | verkadaModule-help.xml |
|---|---|
| Module Name | verkadaModule |
| online version | https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Get-VerkadaAccessGroup.md |
| schema | 2.0.0 |
Gets an Access group in an organization using https://apidocs.verkada.com/reference/getaccessgroupviewv1
Get-VerkadaAccessGroup [[-groupId] <String>] [[-x_verkada_auth_api] <String>] [[-region] <String>]
[-errorsToFile] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Retrieves an access group specified by its Verkada-defined unique identifier(Group ID). The response is the Access Group Metadata Object for the desired Access Group. 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.
Get-VerkadaAccessGroup -groupId '7858d17a-3f72-4506-8532-a4b6ba233c5e'
This will return the Access Group with userId "7858d17a-3f72-4506-8532-a4b6ba233c5e". The token will be populated from the cache created by Connect-Verkada.
Get-VerkadaAccessGroup -groupId '7858d17a-3f72-4506-8532-a4b6ba233c5e' -x_verkada_auth_api 'v2_sd78d9verkada-token'
This will return the Access Group with userId "7858d17a-3f72-4506-8532-a4b6ba233c5e". The token is submitted as a parameter in the call.
Read-VerkadaAccessGroups | Where-Object {$_.name -eq "Executive Access"} | Get-VerkadaAccessGroup
This will return the Access Group named "Executive Access". The token will be populated from the cache created by Connect-Verkada.
The UUID of the group
Type: String
Parameter Sets: (All)
Aliases: group_id
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe public API token obatined via the Login endpoint to be used for calls that hit the public API gateway
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: $Global:verkadaConnection.x_verkada_auth_api
Accept pipeline input: False
Accept wildcard characters: FalseThe region of the public API to be used
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: Api
Accept pipeline input: False
Accept wildcard characters: FalseSwitch to write errors to file
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.