| external help file | verkadaModule-help.xml |
|---|---|
| Module Name | verkadaModule |
| online version | https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Add-VerkadaAccessUserCard.md |
| schema | 2.0.0 |
Creates and adds an Access credential to an Access user in an organization using https://apidocs.verkada.com/reference/postaccesscardviewv1
Add-VerkadaAccessUserCard [-userId <String>] [-externalId <String>] -cardType <String> -cardNumber <String>
[-facilityCode <String>] [-active <Boolean>] [-x_verkada_auth_api <String>] [-region <String>] [-errorsToFile]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Add-VerkadaAccessUserCard [-userId <String>] [-externalId <String>] -cardType <String> -cardNumberHex <String>
[-facilityCode <String>] [-active <Boolean>] [-x_verkada_auth_api <String>] [-region <String>] [-errorsToFile]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Add-VerkadaAccessUserCard [-userId <String>] [-externalId <String>] -cardType <String>
-cardNumberBase36 <String> [-facilityCode <String>] [-active <Boolean>] [-x_verkada_auth_api <String>]
[-region <String>] [-errorsToFile] [-ProgressAction <ActionPreference>] [<CommonParameters>]
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 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-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 token will be populated from the cache created by Connect-Verkada.
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.
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 token will be populated from the cache created by Connect-Verkada.
The UUID of the user
Type: String
Parameter Sets: (All)
Aliases: user_id
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: Falseunique identifier managed externally provided by the consumer
Type: String
Parameter Sets: (All)
Aliases: external_id
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe card type of the credential
Type: String
Parameter Sets: (All)
Aliases: type
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe card number of the credential
Type: String
Parameter Sets: cardNumber
Aliases: card_number
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe card Number Hex of the credential
Type: String
Parameter Sets: cardNumberHex
Aliases: card_number_hex
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe card Number in base36 of the credential
Type: String
Parameter Sets: cardNumberBase36
Aliases: card_number_base36
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe facility code of the credential
Type: String
Parameter Sets: (All)
Aliases: facility_code
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseBool value specifying if the credential is currently active. Default value is False.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: True
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: Named
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: Named
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.