Set-R1RestClientAccess
Set-R1RestClientAccess
SYNOPSIS
Updates the REST client access settings.
SYNTAX
Set-R1RestClientAccess [[-tokenTimeout] <Int32>] [[-cookieTimeout] <Int32>] [[-maxThreads] <Int32>]
[[-alwaysAuthenticate] <Boolean>] [[-enabled] <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates the REST service settings, covering token and cookie lifetimes, the request thread limit, and whether the service is enabled.
The current settings are retrieved before they are updated, and sent back with the supplied values applied over them, so a setting left unspecified keeps its current value. The command therefore issues a GET followed by a PUT, and the account needs permission to read the settings as well as to change them.
EXAMPLES
Example 1
Set-R1RestClientAccess -tokenTimeout 3600
Shortens the REST token lifetime to an hour.
PARAMETERS
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-alwaysAuthenticate
Whether every REST request is authenticated.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-cookieTimeout
How long a REST session cookie remains valid, in seconds.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-enabled
Whether the REST service is enabled.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-maxThreads
The maximum number of threads serving REST requests, 1 to 10000.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-tokenTimeout
How long a REST token remains valid, in seconds.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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.