Get-VPASCustomTheme


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GET CUSTOM THEME DETAILS


Description:

USE THIS FUNCTION TO GET DETAILS FOR A CUSTOM THEME IN CYBERARK


Syntax:

Get-VPASCustomTheme -ThemeName <String> [-ExportToCSV] [-CSVDirectory <String>] [-token <Hashtable>] [<CommonParameters>]

Get-VPASCustomTheme -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-ThemeName <String>
Unique identifier of the target theme

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ExportToCSV [<SwitchParameter>]
Output results to a CSV file found in AppData\Local\VPASModuleOutputs directory

Required: false
Position: named
Default value: False
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-CSVDirectory <String>
Output directory where the exported CSV file will be saved to
Default value: C:\Users\{CurrentUser}\AppData\Local\VPASModuleOutputs\ExportedCSVs

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
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)


Examples:

$CustomThemeDetailsJSON = Get-VPASCustomTheme -ThemeName {THEME NAME VALUE}

$InputParameters = @{
        ThemeName = "vpasdark"
         ExportToCSV = $true|$false
         CSVDirectory = "C:\Temp"
}
$CustomThemeDetailsJSON = Get-VPASCustomTheme -InputParameters $InputParameters


Outputs:

If successful:
{
         "isActive": true,
         "isSystem": false,
         "name": "vpasdark",
         "isDraft": false,
         "images": {
                 "main": {
                         "mainBackgroundImage": "",
                         "mainLogoDark": "vpasdark-20241230115824-mainLogoDark",
                         "advancedSmallLogo": "vpasdark-20241230115824-advancedSmallLogo",
                         "advancedSymbolLogo": "vpasdark-20241230115824-advancedSymbolLogo"
                 }
         },
         "colors": {
                 "colorsStyle": "dark",
                 "definitionByType": {
                         "dark": {
                                 "backgroundMain": "#1E243F",
                                 "borderMain": "#415369",
                                 "textMain": "#FFFFFF",
                                 "disableMain": "#6C6E83",
                                 "disableTextPrimary": "#6C6E83",
                                 "disableBackgroundPrimary": "#36395E",
                                 "successPrimary": "#02DA4F",
                                 "successSecondary": "#21532C",
                                 "warningPrimary": "#FFC107",
                                 "warningSecondary": "#7E4F1B",
                                 "infoPrimary": "#5FA4FF",
                                 "infoSecondary": "#284576",
                                 "errorPrimary": "#FE5D5D",
                                 "errorSecondary": "#740C0F"
                         },
                         "bright": {
                                 "backgroundMain": "#ffffff",
                                 "borderMain": "#1362CB",
                                 "textMain": "#333333",
                                 "disableMain": "#333333",
                                 "disableTextPrimary": "#ffffff",
                                 "disableBackgroundPrimary": "#818080",
                                 "successPrimary": "#008753",
                                 "successSecondary": "#C7F8D2",
                                 "warningPrimary": "#E37500",
                                 "warningSecondary": "#FFEDD9",
                                 "infoPrimary": "#1362CB",
                                 "infoSecondary": "#E6EFFE",
                                 "errorPrimary": "#DA1E28",
                                 "errorSecondary": "#FFDFE0"
                         }
                 },
                 "main": {
                         "mainColor": "#358CFF",
                         "selectedMain": "#4B6799",
                         "hoverMain": "#29589F",
                         "defaultButtonTextPrimary": "#FFFFFF"
                 },
                 "menu": {
                         "menuLogoBackground": "#2F3564",
                         "menuBackground": "#384D7D",
                         "menuHoverBackground": "#3B5EAE",
                         "menuActiveBackgroundPrimary": "#4562A4",
                         "menuActiveBackgroundSecondary": "#96AEE4",
                         "menuText": "#ffffff",
                         "menuTextActive": "#2F3564",
                         "menuIcon": "#5ABDFB"
                 },
                 "advanced": {
                         "backgroundMain": "",
                         "borderMain": "",
                         "textMain": ""
                 }
         }
}

$false if failed