mirror of
https://github.com/snazy2000/SnipeitPS.git
synced 2025-12-15 02:35:47 +00:00
93 lines
3.1 KiB
PowerShell
93 lines
3.1 KiB
PowerShell
<#
|
|
.SYNOPSIS
|
|
Sets authetication information
|
|
|
|
.DESCRIPTION
|
|
Sets apikey and url to connect Snipe-It system.
|
|
Based on Set-SnipeitInfo command, what is now just combatipility wrapper
|
|
and calls Connect-SnipeitPS
|
|
|
|
.PARAMETER url
|
|
URL of Snipeit system.
|
|
|
|
.PARAMETER apiKey
|
|
User's API Key for Snipeit.
|
|
|
|
.PARAMETER secureApiKey
|
|
Snipe it Api key as securestring
|
|
|
|
.PARAMETER siteCred
|
|
PSCredential where username shoul be snipe it url and password should be
|
|
snipe it apikey.
|
|
|
|
.EXAMPLE
|
|
Connect-SnipeitPS -Url $url -apiKey $myapikey
|
|
Connect to Snipe it api.
|
|
|
|
.EXAMPLE
|
|
Connect-SnipeitPS -Url $url -SecureApiKey $myapikey
|
|
Connects to Snipe it api with apikey stored to securestring
|
|
|
|
.EXAMPLE
|
|
Connect-SnipeitPS -siteCred (Get-Credential -message "Use site url as username and apikey as password")
|
|
Connect to Snipe It with PSCredential object.
|
|
To use saved creadentials yu can use export-clixml and import-clixml commandlets.
|
|
|
|
.EXAMPLE
|
|
Build credential with apikey value from secret vault (Microsoft.PowerShell.SecretManagement)
|
|
$siteurl = "https://mysnipeitsite.url"
|
|
$apikey = Get-SecretInfo -Name SnipeItApiKey
|
|
$siteCred = New-Object -Type PSCredential -Argumentlist $siteurl,$spikey
|
|
Connect-SnipeitPS -siteCred $siteCred
|
|
|
|
|
|
|
|
#>
|
|
function Connect-SnipeitPS {
|
|
[CmdletBinding(
|
|
DefaultParameterSetName = 'Connect with url and apikey'
|
|
)]
|
|
[System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseShouldProcessForStateChangingFunctions', '')]
|
|
|
|
param (
|
|
[Parameter(ParameterSetName='Connect with url and apikey',Mandatory=$true)]
|
|
[Parameter(ParameterSetName='Connect with url and secure apikey',Mandatory=$true)]
|
|
[Uri]$url,
|
|
|
|
[Parameter(ParameterSetName='Connect with url and apikey',Mandatory=$true)]
|
|
[String]$apiKey,
|
|
|
|
[Parameter(ParameterSetName='Connect with url and secure apikey',Mandatory=$true)]
|
|
[SecureString]$secureApiKey,
|
|
|
|
[Parameter(ParameterSetName='Connect with credential',Mandatory=$true)]
|
|
[PSCredential]$siteCred
|
|
)
|
|
|
|
|
|
PROCESS {
|
|
switch ($PsCmdlet.ParameterSetName) {
|
|
'Connect with url and apikey' {
|
|
$SnipeitPSSession.url = $url.TrimEnd('/')
|
|
$SnipeitPSSession.apiKey = ConvertTo-SecureString -AsPlainText -String $apiKey
|
|
}
|
|
|
|
'Connect with url and secure apikey' {
|
|
$SnipeitPSSession.url = $url.TrimEnd('/')
|
|
$SnipeitPSSession.apiKey = $secureApiKey
|
|
}
|
|
|
|
'Connect with credential' {
|
|
$SnipeitPSSession.url = ($siteCred.GetNetworkCredential().UserName).TrimEnd('/')
|
|
$SnipeitPSSession.apiKey = $siteCred.GetNetworkCredential().SecurePassword
|
|
}
|
|
}
|
|
|
|
Write-Debug "Site-url $($SnipeitPSSession.url)"
|
|
Write-Debug "Site apikey: $($SnipeitPSSession.apiKey)"
|
|
|
|
if (-not (Test-SnipeitPSConnection)) {
|
|
throw "Cannot verify connection to snipe it. For the start try to check url and provided apikey or credential parameters"
|
|
}
|
|
}
|
|
}
|