Skip to content

Latest commit

 

History

History
142 lines (108 loc) · 3.64 KB

Get-VerkadaCommandUser.md

File metadata and controls

142 lines (108 loc) · 3.64 KB
external help file Module Name online version schema
verkadaModule-help.xml
verkadaModule
2.0.0

Get-VerkadaCommandUser

SYNOPSIS

Gets a Command user using https://apidocs.verkada.com/reference/getuserviewv1

SYNTAX

Get-VerkadaCommandUser [[-userId] <String>] [[-externalId] <String>] [[-x_verkada_auth_api] <String>]
 [[-region] <String>] [-errorsToFile] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Returns a user for an organization based on either provided user ID or an external ID set during creation. 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.

EXAMPLES

EXAMPLE 1

Get-VerkadaCommandUser -userId '3651fbcb-f8ba-4248-ad70-3f6512fd7b6c' 
This will attempt to get the user details of a user with the userId of '3651fbcb-f8ba-4248-ad70-3f6512fd7b6c'.  The token will be populated from the cache created by Connect-Verkada.

EXAMPLE 2

Get-VerkadaCommandUser -externalId 'UserUPN@contoso.com' -x_verkada_auth_api 'sd78ds-uuid-of-verkada-token'
This will attempt to get the user details of a user with the externalId UserUPN@contoso.com.  The token is submitted as a parameter in the call.

PARAMETERS

-userId

The UUID of the user

Type: String
Parameter Sets: (All)
Aliases: user_id

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-externalId

unique identifier managed externally provided by the consumer

Type: String
Parameter Sets: (All)
Aliases: external_id

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-x_verkada_auth_api

The 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: 3
Default value: $Global:verkadaConnection.x_verkada_auth_api
Accept pipeline input: False
Accept wildcard characters: False

-region

The region of the public API to be used

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: Api
Accept pipeline input: False
Accept wildcard characters: False

-errorsToFile

Switch 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

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Get-VerkadaCommandUser.md