| external help file | verkadaModule-help.xml |
|---|---|
| Module Name | verkadaModule |
| online version | https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Set-VerkadaAccessUserEmployementDetail.md |
| schema | 2.0.0 |
Sets the employment details for an Access User in an organization
Set-VerkadaAccessUserEmployementDetail [-org_id <String>] [-email <String>] [-firstName <String>]
[-lastName <String>] [-employeeId <String>] [-employeeTitle <String>] [-department <String>]
[-departmentId <String>] [-companyName <String>] [-usr <String>] [-x_verkada_token <String>]
[-x_verkada_auth <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Set-VerkadaAccessUserEmployementDetail [-org_id <String>] -userId <String> [-employeeId <String>]
[-employeeTitle <String>] [-department <String>] [-departmentId <String>] [-companyName <String>]
[-usr <String>] [-x_verkada_token <String>] [-x_verkada_auth <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
This function is used to set the employment details for an Access User in an organization. While userId is preferable to use this function, email or firstName/lastName can be used to set the details as it will attempt to use the Find-VerkadaUserId function to lookup the userId. 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-VerkadaAccessUserEmployementDetail -userId 'gjg547-uuid-of-user' -employeeId '9999sd' -department 'sales' -departmentId 'salesUS' -employeeTitle 'Account Executive' -companyName 'Contoso'
This will set the employment details specified in the parameters for the user specified. The org_id and tokens will be populated from the cached created by Connect-Verkada.
Set-VerkadaAccessUserEmployementDetail -userId 'gjg547-uuid-of-user' -employeeId '9999sd' -department 'sales' -departmentId 'salesUS' -employeeTitle 'Account Executive' -companyName 'Contoso' -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 set the employment details specified in the parameters for the user specified. The org_id and tokens are submitted as parameters in the call.
Import-Csv ./myUsers.csv | Set-VerkadaAccessUserEmployementDetail
This will set the employment details for every row in the csv file which contains userId, employeeId, employeeTitle, department, departmentId, and companyName. 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
Type: String
Parameter Sets: userId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe email address of the user being updated
Type: String
Parameter Sets: search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe first name of the user being updated
Type: String
Parameter Sets: search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe last name of the user being updated
Type: String
Parameter Sets: search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe employee ID of the user
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe title of the user
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe department of the user
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe departmentId of the user
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe company name of the user
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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: 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: 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.