Set-SkyTapAuth

NAME Set-SkyTapAuth



SYNOPSIS

Prepares SkyTap Username & API Key for Authentication





SYNTAX

Set-SkyTapAuth [-Username] <String> [-APIKey] <String> [<CommonParameters>]





DESCRIPTION

Converts SkyTap Username:APIKey to Base64 encoded format for

authenticating to the SkyTap API using Basic Authentication.





PARAMETERS

-Username <String>

SkyTap Username (i.e. address@email.com)



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-APIKey <String>

SkyTap API Key (https://help.skytap.com/kb-find-api-tok ... pi%20token)



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Returns Base64-encoded Username:APIKey string.





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>$authSkyTap = Set-SkyTapAuth -Username Joseph.Garcia@cyberark.com -Password 1caf650714f5acec93a490ees9c













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>[xml]$config = Get-Content -Path "settings.xml"



$authSkyTap = Set-SkyTapAuth -Username ${config.Settings.SkyTap.Authentication.SkyTapAPIUser} `

-Password ${config.Settings.SkyTap.Authentication.SkyTapAPIPass}











RELATED LINKS