Get-KnowBe4User

NAME Get-KnowBe4User



SYNTAX

Get-KnowBe4User [-BaseURL] {US | EU} [-AccessToken] <string> [[-Status] {Active | Archived}] [[-UserID] <string>]

[[-GroupID] <string>] [-Expand] [<CommonParameters>]





PARAMETERS

-AccessToken <string>

This token is generated by KnowBe4 and accessible from your Account Settings page under 'API.' You must check

'Enable API Access' to use this token.



Required? true

Position? 1

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-BaseURL <string>

If your server URL is training.knowbe4.com, your base URL is 'US'. If your server URL is eu.knowbe4.com, your

base URL is 'EU.'



Required? true

Position? 0

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-Expand

Expands groups to provide additional details.



Required? false

Position? Named

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-GroupID <string>

Specify a user group to return.



Required? false

Position? 4

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-Status <string>

Return all users of this status. Ex. Active, Archived.



Required? false

Position? 2

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



-UserID <string>

Get a specific user.



Required? false

Position? 3

Accept pipeline input? false

Parameter set name (All)

Aliases None

Dynamic? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).





INPUTS

None





OUTPUTS

System.Object



ALIASES

None





REMARKS

None