Functions/Applications/Add-PASApplication.ps1
|
function Add-PASApplication { <# .SYNOPSIS Adds a new application to the Vault .DESCRIPTION Adds a new application to the Vault. Manage Users permission is required. .PARAMETER AppID The application name. Must be fewer than 128 characters. Cannot include ampersand ("&") character. Can include "@" character, but any searches for applications cannot include this character. .PARAMETER Description Description of the application, no longer than 99 characters. .PARAMETER Location The location of the application in the vault hierarchy. Note: to insert a backslash in the location path, use a double backslash. .PARAMETER AccessPermittedFrom The start hour that access is permitted to the application. Valid values are 0-23. .PARAMETER AccessPermittedTo The end hour that access to the application is permitted. Valid values are 0-23. .PARAMETER ExpirationDate The date when the application expires. .PARAMETER Disabled Boolean value, denoting if the application is disabled or not. .PARAMETER BusinessOwnerFName The first name of the business owner. Specify up to 29 characters. .PARAMETER BusinessOwnerLName The last name of the business owner. .PARAMETER BusinessOwnerEmail The email address of the business owner .PARAMETER BusinessOwnerPhone The phone number of the business owner. Specify up to 24 characters. .EXAMPLE Add-PASApplication -AppID NewApp -Description "A new application" -Location "\" ` -AccessPermittedFrom 9 -AccessPermittedTo 17 -BusinessOwnerEmail 'appowner@company.com' Will add a new application called "NewApp", in the root location, accessible from 9am to 5pm .INPUTS All parameters can be piped by property name .LINK https://pspas.pspete.dev/commands/Add-PASApplication #> [CmdletBinding()] param( [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [ValidateNotNullOrEmpty()] [ValidateLength(1, 127)] [ValidateScript( { $_ -notmatch ".*(\&).*" })] [string]$AppID, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [ValidateLength(0, 99)] [string]$Description, [parameter( Mandatory = $true, ValueFromPipelinebyPropertyName = $true )] [string]$Location, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [ValidateRange(0, 23)] [int]$AccessPermittedFrom, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [ValidateRange(0, 23)] [int]$AccessPermittedTo, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [datetime]$ExpirationDate, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [boolean]$Disabled, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [ValidateLength(0, 29)] [string]$BusinessOwnerFName, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [string]$BusinessOwnerLName, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [string]$BusinessOwnerEmail, [parameter( Mandatory = $false, ValueFromPipelinebyPropertyName = $true )] [ValidateLength(0, 24)] [string]$BusinessOwnerPhone ) BEGIN { }#begin PROCESS { #WebService URL $URI = "$Script:BaseURI/WebServices/PIMServices.svc/Applications" #Get request parameters $boundParameters = $PSBoundParameters | Get-PASParameter If ($PSBoundParameters.ContainsKey("ExpirationDate")) { #Convert ExpiryDate to string in Required format $Date = (Get-Date $ExpirationDate -Format MM-dd-yyyy).ToString() #Include date string in request $boundParameters["ExpirationDate"] = $Date } #Create Request Body $body = @{ "application" = $boundParameters } | ConvertTo-Json #Send Request Invoke-PASRestMethod -Uri $URI -Method POST -Body $Body -WebSession $Script:WebSession }#process END { }#end } |