| external help file | verkadaModule-help.xml |
|---|---|
| Module Name | verkadaModule |
| online version | https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Add-VerkadaAccessGroup.md |
| schema | 2.0.0 |
Creates an Access group in an organization using https://apidocs.verkada.com/reference/postaccessgroupviewv1
Add-VerkadaAccessGroup [[-name] <String>] [[-x_verkada_auth_api] <String>] [[-region] <String>] [-errorsToFile]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
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 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.
Add-VerkadaAccessGroup -name 'Newgroup'
This will add the access group with the name "NewGroup". The token will be populated from the cache created by Connect-Verkada.
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.
The name of the group
Type: String
Parameter Sets: (All)
Aliases: group_name, groupName
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.