Skip to content

Find-VerkadaCommandUser.md

Latest commit

 

History

History
192 lines (148 loc) · 5.07 KB

Find-VerkadaCommandUser.md

File metadata and controls

192 lines (148 loc) · 5.07 KB
external help file verkadaModule-help.xml
Module Name verkadaModule
online version https://github.com/bepsoccer/verkadaModule/blob/master/docs/function-documentation/Find-VerkadaCommandUser.md
schema 2.0.0

Find-VerkadaCommandUser

SYNOPSIS

Finds the Command users' details in an organization

SYNTAX

userId (Default)

Find-VerkadaCommandUser -userId <String> [-org_id <String>] [-x_verkada_token <String>]
 [-x_verkada_auth <String>] [-usr <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

email

Find-VerkadaCommandUser -email <String> [-org_id <String>] [-x_verkada_token <String>]
 [-x_verkada_auth <String>] [-usr <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

name

Find-VerkadaCommandUser -Name <String> [-org_id <String>] [-x_verkada_token <String>]
 [-x_verkada_auth <String>] [-usr <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This function is used to find all the details of Command users.

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.

EXAMPLES

EXAMPLE 1

Find-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 org_id and tokens will be populated from the cached created by Connect-Verkada.

EXAMPLE 2

Find-VerkadaCommandUser -email 'bob.smith@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 find the user details of a user with email address bob.smith@contoso.com.  The org_id and tokens are submitted as parameters in the call.

EXAMPLE 3

Find-VerkadaCommandUser -Name 'Bob Smith'
This will attempt to find the user details of a user named "Bob Smith".  Depending of the name submitted, i.e. could just be a first or last name, multiple results could be returned.  The org_id and tokens will be populated from the cached created by Connect-Verkada.

PARAMETERS

-userId

The userId of the user being searched for

Type: String
Parameter Sets: userId
Aliases:

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

-email

The email address of the user being searched for

Type: String
Parameter Sets: email
Aliases:

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

-Name

The name of the user being searched for

Type: String
Parameter Sets: name
Aliases:

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

-org_id

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: False

-x_verkada_token

The 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: False

-x_verkada_auth

The 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

-usr

The 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

-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/Find-VerkadaCommandUser.md