| external help file | verkadaModule-help.xml |
|---|---|
| Module Name | verkadaModule |
| online version | https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaAccessUserEmail.md |
| schema | 2.0.0 |
Sets the Access users' emails
Set-VerkadaAccessUserEmail [-org_id <String>] [-userId] <String> [-email] <String> [-x_verkada_token <String>]
[-x_verkada_auth <String>] [-usr <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
This function is used to edit the email address of a non-SCIM Access user. Currently only users with no emails will this work for. 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.
Set-VerkadaAccessUserEmail -userId 'bdae7dbd-54f1-4aff-94ed-0990e1fc56f8' -email 'newEmail@contoso.com'
This will attempt to set the Access user email of a user with the the userId of 'bdae7dbd-54f1-4aff-94ed-0990e1fc56f8'. The org_id and tokens will be populated from the cached created by Connect-Verkada.
Set-VerkadaAccessUserEmail -userId 'bdae7dbd-54f1-4aff-94ed-0990e1fc56f8' -email 'newEmail@contoso.com' -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 attempt to set the Access user email of a user with the the userId of 'bdae7dbd-54f1-4aff-94ed-0990e1fc56f8'. The org_id and tokens are submitted as parameters in the call.
Import-Csv users.csv | Set-VerkadaAccessUserEmail
This will attempt to set the Access user email of a the userIds in the csv using the fields "userId,email". These must be the headers of the data being piped to the function. The org_id and tokens will be populated from the cached created by Connect-Verkada.
The UUID of the organization the user belongs to
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: $Global:verkadaConnection.org_id
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe UUID of the user who's email is being edited
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe email address of the user being edited
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
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: Named
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: Named
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: Named
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.