Add-AuvikAPIKey

SYNOPSIS

Sets the API public & secret keys used to authenticate API calls.

SYNTAX

Add-AuvikAPIKey [-Api_UserName] <String> [[-Api_Key] <String>] [<CommonParameters>]

DESCRIPTION

The Add-AuvikAPIKey cmdlet sets the API public & secret keys which are used to authenticate all API calls made to Auvik.

Once the API public & secret keys are defined, the secret key is encrypted using SecureString.

The Auvik API public & secret keys are generated via the Auvik portal at Admin > Integrations

EXAMPLES

EXAMPLE 1

Add-AuvikAPIKey

Prompts to enter in the API public key and secret key.

EXAMPLE 2

Add-AuvikAPIKey -Api_UserName '12345'

The Auvik API will use the string entered into the [ -Api_UserName ] parameter as the public key & will then prompt to enter in the secret key.

EXAMPLE 3

'12345' | Add-AuvikAPIKey

The Auvik API will use the string entered as the secret key & will prompt to enter in the public key.

PARAMETERS

-Api_UserName

Defines your API username

Type: String
Parameter Sets: (All)
Aliases:

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

-Api_Key

Defines your API secret key.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
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/Auvik-PowerShellWrapper/site/Internal/Add-AuvikAPIKey.html