Test-MyITProcessAPIKey

SYNOPSIS

Test the MyITProcess API key.

SYNTAX

Test-MyITProcessAPIKey [[-base_uri] <String>] [<CommonParameters>]

DESCRIPTION

The Test-MyITProcessAPIKey cmdlet tests the base URI & API key that was defined in the Add-MyITProcessBaseURI & Add-MyITProcessAPIKey cmdlets.

This functions validates authorization to the /users endpoint

EXAMPLES

EXAMPLE 1

Test-MyITProcessBaseURI

Tests the base URI & API key that was defined in the Add-MyITProcessBaseURI & Add-MyITProcessAPIKey cmdlets.

The default full base uri test path is: https://reporting.live.myitprocess.com/api/v1/clients

EXAMPLE 2

Test-MyITProcessBaseURI -base_uri http://myapi.gateway.example.com

Tests the base URI & API key that was defined in the Add-MyITProcessBaseURI & Add-MyITProcessAPIKey cmdlets.

The full base uri test path in this example is: http://myapi.gateway.example.com/clients

PARAMETERS

-base_uri

Define the base URI for the MyITProcess API connection using MyITProcess’s URI or a custom URI.

The default base URI is https://reporting.live.myitprocess.com/api/v1

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: $MyITProcess_Base_URI
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/Test-MyITProcessAPIKey.html