Set-LMAPIToken
Syntax
Section titled “Syntax”Id (Default)
Section titled “Id (Default)”Set-LMAPIToken -AdminId <Int32> -Id <Int32> [-Note <String>] [-Status <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Set-LMAPIToken -AdminName <String> -Id <Int32> [-Note <String>] [-Status <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Section titled “Description”The Set-LMAPIToken function modifies the properties of an existing API token in LogicMonitor, including its note and status.
Examples
Section titled “Examples”Example 1
Section titled “Example 1”Set-LMAPIToken -AdminId 123 -Id 456 -Note "Updated token" -Status "suspended"Updates the API token with ID 456 owned by admin 123 with a new note and status.Parameters
Section titled “Parameters”-AdminId
Section titled “-AdminId”Specifies the ID of the admin user who owns the token. This parameter is mandatory when using the ‘Id’ parameter set.
Type: Int32Parameter Sets: IdAliases:
Required: TruePosition: NamedDefault value: 0Accept pipeline input: True (ByPropertyName)Accept wildcard characters: False-AdminName
Section titled “-AdminName”Specifies the name of the admin user who owns the token. This parameter is mandatory when using the ‘Name’ parameter set.
Type: StringParameter Sets: NameAliases:
Required: TruePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: FalseSpecifies the ID of the API token to modify.
Type: Int32Parameter Sets: (All)Aliases:
Required: TruePosition: NamedDefault value: 0Accept pipeline input: True (ByPropertyName)Accept wildcard characters: FalseSpecifies a new note for the API token.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Status
Section titled “-Status”Specifies the new status for the API token. Valid values are “active” or “suspended”.
Type: StringParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-WhatIf
Section titled “-WhatIf”Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameterParameter Sets: (All)Aliases: wi
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Confirm
Section titled “-Confirm”Prompts you for confirmation before running the cmdlet.
Type: SwitchParameterParameter Sets: (All)Aliases: cf
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-ProgressAction
Section titled “-ProgressAction”Fill ProgressAction Description
Type: ActionPreferenceParameter Sets: (All)Aliases: proga
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: FalseCommonParameters
Section titled “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
Section titled “Inputs”You can pipe objects containing AdminId and Id properties to this function.
Section titled “You can pipe objects containing AdminId and Id properties to this function.”Outputs
Section titled “Outputs”Returns a LogicMonitor.APIToken object containing the updated token information.
Section titled “Returns a LogicMonitor.APIToken object containing the updated token information.”This function requires a valid LogicMonitor API authentication.