Get-AuvikAPIKey

SYNOPSIS

Gets the Auvik API username & API key global variables

SYNTAX

Get-AuvikAPIKey [-AsPlainText] [<CommonParameters>]

DESCRIPTION

The Get-AuvikAPIKey cmdlet gets the Auvik API username & API key global variables and returns them as an object

EXAMPLES

EXAMPLE 1

Get-AuvikAPIKey

Gets the Auvik API username & API key global variables and returns them as an object with the secret key as a SecureString

EXAMPLE 2

Get-AuvikAPIKey -AsPlainText

Gets the Auvik API username & API key global variables and returns them as an object with the secret key as plain text

PARAMETERS

-AsPlainText

Decrypt and return the API key in plain text

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

N\A

RELATED LINKS

https://celerium.github.io/Celerium.Auvik/site/Internal/Get-AuvikAPIKey.html