Skip to content

Get-S1Group

SYNOPSIS

Retrieve information related to SentinelOne groups.

SYNTAX

All (Default)

Get-S1Group [-SiteID <String[]>] [-AccountID <String[]>] [-Type <String>] [<CommonParameters>]

Name

Get-S1Group -Name <String> [-SiteID <String[]>] [-AccountID <String[]>] [-Type <String>] [<CommonParameters>]

GroupID

Get-S1Group -GroupID <String[]> [-SiteID <String[]>] [-AccountID <String[]>] [-Type <String>]
 [<CommonParameters>]

RegistrationToken

Get-S1Group [-SiteID <String[]>] [-AccountID <String[]>] [-Type <String>] -RegistrationToken <String>
 [<CommonParameters>]

DESCRIPTION

This function retrieves information related to SentinelOne groups using various filters such as group name, group ID, site ID, account ID, type, or registration token. It sends a GET request to the `/web/api/v2.1/groups` endpoint and returns the data.

EXAMPLES

EXAMPLE 1

Get-S1Group -Name "ExampleGroup"

Retrieves information for the group named "ExampleGroup".

EXAMPLE 2

Get-S1Group -GroupID @("group1", "group2")

Retrieves information for the specified group IDs.

EXAMPLE 3

Get-S1Group -SiteID "site1" -AccountID "account1"

Retrieves groups for the specified site and account IDs.

EXAMPLE 4

Get-S1Group -Type "static"

Retrieves all static groups.

EXAMPLE 5

Get-S1Group -RegistrationToken "token123"

Retrieves the group associated with the specified registration token.

PARAMETERS

-Name

Filter groups by name.

Type: String
Parameter Sets: Name
Aliases:

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

-GroupID

Filter groups by group ID.

Type: String[]
Parameter Sets: GroupID
Aliases:

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

-SiteID

Filter groups by site ID.

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

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

-AccountID

Filter groups by account ID.

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

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

-Type

Filter groups by type. Valid values are "static" or "dynamic".

Type: String
Parameter Sets: (All)
Aliases:

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

-RegistrationToken

Retrieve a group based on its registration token.

Type: String
Parameter Sets: RegistrationToken
Aliases:

Required: True
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