Add-MyITProcessAPIKey

SYNOPSIS

Sets your API key used to authenticate all API calls.

SYNTAX

Add-MyITProcessAPIKey [[-Api_Key] <String>] [<CommonParameters>]

DESCRIPTION

The Add-MyITProcessAPIKey cmdlet sets your API key which is used to authenticate all API calls made to MyITProcess. Once the API key is defined by Add-MyITProcessAPIKey, it is encrypted using SecureString.

The MyITProcess API keys are generated via the MyITProcess web interface at Organization Settings > API Keys.

EXAMPLES

EXAMPLE 1

Add-MyITProcessAPIKey

Prompts to enter in the API Key

EXAMPLE 2

Add-MyITProcessAPIKey -Api_key '12345'

The MyITProcess API will use the string entered into the [ -Api_Key ] parameter.

EXAMPLE 3

'12345' | Add-MyITProcessAPIKey

The Add-MyITProcessAPIKey function will use the string passed into it as its API key.

PARAMETERS

-Api_Key

Define your API key that was generated from MyITProcess.

Type: String
Parameter Sets: (All)
Aliases: ApiKey

Required: False
Position: 1
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/MyITProcess-PowerShellWrapper/site/internal/Add-MyITProcessAPIKey.html