Skip to content

Set-S1ModuleConfiguration

SYNOPSIS

Set the PS-SentinelOne module configuration values for connecting to the SentinelOne console.

SYNTAX

Set-S1ModuleConfiguration [[-URI] <String>] [[-ApiToken] <String>] [[-TemporaryToken] <String>] [-Persist]
 [<CommonParameters>]

DESCRIPTION

This function sets the PS-SentinelOne module configuration values for connecting to the SentinelOne console. Values can be set for the session only or persisted to disk. Tokens are securely stored when persisted.

EXAMPLES

EXAMPLE 1

Set-S1ModuleConfiguration -URI "https://sentinelone.example.com" -ApiToken "YourApiTokenHere"

Sets the URI and API token for the SentinelOne console for the current session.

EXAMPLE 2

Set-S1ModuleConfiguration -URI "https://sentinelone.example.com" -TemporaryToken "YourTemporaryTokenHere" -Persist

Sets the URI and temporary token for the SentinelOne console and persists the configuration to disk.

EXAMPLE 3

Set-S1ModuleConfiguration -ApiToken "YourApiTokenHere" -Persist

Sets the API token for the SentinelOne console and persists the configuration to disk.

PARAMETERS

-URI

Set the URI for your SentinelOne management console.

Type: String
Parameter Sets: (All)
Aliases:

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

-ApiToken

Set your API token, retrieved from the API Token section of your user account in the SentinelOne management console.

Type: String
Parameter Sets: (All)
Aliases:

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

-TemporaryToken

Set your temporary token retrieved from the authentication API, using Get-S1Token.

Type: String
Parameter Sets: (All)
Aliases:

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

-Persist

Switch to specify that the configuration values should be saved to disk. Tokens are securely stored in the user's local AppData directory.

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