Skip to content

Get-S1Account

SYNOPSIS

Retrieve SentinelOne account information.

SYNTAX

Get-S1Account [[-Name] <String>] [[-AccountID] <String[]>] [[-Count] <Int32>] [[-SortBy] <String>]
 [[-SortOrder] <String>] [-CountOnly] [<CommonParameters>]

DESCRIPTION

This function retrieves SentinelOne account information based on the provided filters. It supports filtering by account name, account IDs, and other properties. The results can be sorted, limited, or returned as a count-only response.

EXAMPLES

EXAMPLE 1

Get-S1Account -Name "ExampleAccount"

Retrieves information for the account named "ExampleAccount".

EXAMPLE 2

Get-S1Account -AccountID @("id1", "id2")

Retrieves information for the accounts with the specified IDs.

EXAMPLE 3

Get-S1Account -SortBy "name" -SortOrder "asc" -Count 10

Retrieves up to 10 accounts sorted by name in ascending order.

EXAMPLE 4

Get-S1Account -CountOnly

Returns the count of all accounts.

PARAMETERS

-Name

Filter the accounts list to a specific name.

Type: String
Parameter Sets: (All)
Aliases:

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

-AccountID

Filter the accounts list to specific account IDs.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-Count

Limit the number of retrieved accounts.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

Sort the accounts by a specific property. Valid values include "accountType", "activeAgents", "createdAt", "expiration", "id", "name", "numberOfSites", "state", and "updatedAt".

Type: String
Parameter Sets: (All)
Aliases:

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

-SortOrder

Specify the sort order. Valid values are "asc" or "desc".

Type: String
Parameter Sets: (All)
Aliases:

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

-CountOnly

A switch to return only the count of matching accounts.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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