| external help file | verkadaModule-help.xml |
|---|---|
| Module Name | verkadaModule |
| online version | https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Read-VerkadaCommandUsers.md |
| schema | 2.0.0 |
Gathers all Command Users in an organization
Read-VerkadaCommandUsers [[-org_id] <String>] [[-query] <Object>] [[-variables] <Object>]
[-x_verkada_token <String>] [-x_verkada_auth <String>] [-usr <String>] [-refresh]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
This function will return all the active Command users in an organization. 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.
Read-VerkadaCommandUsers
This will return all the active users in an organization. The org_id and tokens will be populated from the cached created by Connect-Verkada.
Read-VerkadaCommandUsers -userId 'aefrfefb-3429-39ec-b042-userAC' -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 return all the active users in an organization. The org_id and tokens will be populated from the cached created by Connect-Verkada.
Read-VerkadaCommandUsers -refresh
This will return all the active users in an organization with the most recent data available from Command. 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: 1
Default value: $Global:verkadaConnection.org_id
Accept pipeline input: False
Accept wildcard characters: FalseThis is the graphql query to be submitted (do not use unless you know what you are doing)
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis is the graphql variables to be submitted (do not use unless you know what you are doing)
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
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: 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: FalseSwitch to force a refreshed list of users from Command
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.