| external help file | Module Name | online version | schema |
|---|---|---|---|
KnowBe4-Partner-help.xml |
KnowBe4-Partner |
2.0.0 |
Returns all managed accounts.
Get-KB4ManagedAccount [[-Per] <Int32>] [[-Page] <Int32>] [[-Search] <String>] [-ArchivedUsers <String>]
[[-Status] <String>] [[-BillingType] <String>] [[-SortField] <String>] [[-SortDirection] <String>]
[[-OtherPartnersAccounts] <String>] [<CommonParameters>]Returns all managed accounts. You can filter the results by searching for a particular client name.
Get-KB4ManagedAccount -Search 'contoso' -BillingType 'PAID' -Status 'ACTIVE'This command returns the client account 'contoso'. The search parameter can be used on its own if needed.
The current billing type of the managed account.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ANY, PAID, TRIAL, FREE
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseTBD. Default value is ALL.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ALL
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe page number you want returned.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis specifies how many results you want returned. Default is 25 (per page).
Type: Int32
Parameter Sets: (All)
Aliases:
Accepted values: 25, 100
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis specifies which client name you want to search for.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe sort direction of all returned results.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ASCENDING, DESCENDING
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe field in which to sort by.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ORGANIZATION, DATE_CREATED, SEATS, USERS, PHISH_PRONE, PSTS
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe current status of the managed client account.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ALL, ACTIVE, ARCHIVED
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseInclude archived users. Default is false.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: true, false
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.
Author: Terry Wilson