v2025/src/PSSailpoint.V2025/Api/V2025PrivilegeCriteriaApi.ps1
|
# # Identity Security Cloud V2025 API # Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. # Version: v2025 # Generated by OpenAPI Generator: https://openapi-generator.tech # <# .SYNOPSIS Create custom privilege criteria .DESCRIPTION Use this API to create a custom privilege criteria .PARAMETER CreatePrivilegeCriteriaRequest Create custom privilege criteria request body. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS PrivilegeCriteriaDTO #> function New-V2025CustomPrivilegeCriteria { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${CreatePrivilegeCriteriaRequest}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-V2025CustomPrivilegeCriteria' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/criteria/privilege' if (!$CreatePrivilegeCriteriaRequest) { throw "Error! The required parameter `CreatePrivilegeCriteriaRequest` missing when calling createCustomPrivilegeCriteria." } if ($LocalVarContentTypes.Contains('application/json-patch+json') -or ($CreatePrivilegeCriteriaRequest -is [array])) { $LocalVarBodyParameter = $CreatePrivilegeCriteriaRequest | ConvertTo-Json -AsArray -Depth 100 } else { $LocalVarBodyParameter = $CreatePrivilegeCriteriaRequest | ForEach-Object { # Get array of names of object properties that can be cast to boolean TRUE # PSObject.Properties - https://msdn.microsoft.com/en-us/library/system.management.automation.psobject.properties.aspx $NonEmptyProperties = $_.psobject.Properties | Where-Object {$null -ne $_.Value} | Select-Object -ExpandProperty Name # Convert object to JSON with only non-empty properties $_ | Select-Object -Property $NonEmptyProperties | ConvertTo-Json -Depth 100 } } $LocalVarResult = Invoke-V2025ApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "PrivilegeCriteriaDTO" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Delete privilege criteria .DESCRIPTION Use this API to delete a specific custom privilege criteria. .PARAMETER CriteriaId The Id of the custom privilege criteria to delete. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Remove-V2025CustomPrivilegeCriteria { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${CriteriaId}, [Switch] $WithHttpInfo ) Process { 'Calling method: Remove-V2025CustomPrivilegeCriteria' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/criteria/privilege/{criteriaId}' if (!$CriteriaId) { throw "Error! The required parameter `CriteriaId` missing when calling deleteCustomPrivilegeCriteria." } $LocalVarUri = $LocalVarUri.replace('{criteriaId}', [System.Web.HTTPUtility]::UrlEncode($CriteriaId)) $LocalVarResult = Invoke-V2025ApiClient -Method 'DELETE' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get privilege criteria .DESCRIPTION Use this API to get a specific privilege criteria. .PARAMETER CriteriaId The Id of the privilege criteria record to return. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS PrivilegeCriteriaDTO #> function Get-V2025PrivilegeCriteria { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${CriteriaId}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-V2025PrivilegeCriteria' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/criteria/privilege/{criteriaId}' if (!$CriteriaId) { throw "Error! The required parameter `CriteriaId` missing when calling getPrivilegeCriteria." } $LocalVarUri = $LocalVarUri.replace('{criteriaId}', [System.Web.HTTPUtility]::UrlEncode($CriteriaId)) $LocalVarResult = Invoke-V2025ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "PrivilegeCriteriaDTO" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS List privilege criteria .DESCRIPTION Use this API to list all privilege criteria matching a filter .PARAMETER Filters Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq* **sourceId**: *eq* **privilegeLevel**: *eq* **Supported composite operators**: *and* All filter values are case-sensitive for this API. For example, the following is valid: `?filters=type eq ""CUSTOM"" and sourceId eq ""2c91809175e6c63f0175fb5570220569""` .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS PrivilegeCriteriaDTO[] #> function Get-V2025PrivilegeCriteria { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Filters}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-V2025PrivilegeCriteria' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/criteria/privilege' if (!$Filters) { throw "Error! The required parameter `Filters` missing when calling listPrivilegeCriteria." } $LocalVarQueryParameters['filters'] = $Filters $LocalVarResult = Invoke-V2025ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "PrivilegeCriteriaDTO[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Update privilege criteria .DESCRIPTION Use this API to update a specific custom privilege criteria by overwriting the information with new information. .PARAMETER CriteriaId The Id of the privilege criteria record to return. .PARAMETER PrivilegeCriteriaDTO The new version of the custom privilege criteria. This overwrites the existing privilege criteria. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS PrivilegeCriteriaDTO #> function Send-V2025CustomPrivilegeCriteriaValue { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${CriteriaId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${PrivilegeCriteriaDTO}, [Switch] $WithHttpInfo ) Process { 'Calling method: Send-V2025CustomPrivilegeCriteriaValue' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/criteria/privilege/{criteriaId}' if (!$CriteriaId) { throw "Error! The required parameter `CriteriaId` missing when calling putCustomPrivilegeCriteriaValue." } $LocalVarUri = $LocalVarUri.replace('{criteriaId}', [System.Web.HTTPUtility]::UrlEncode($CriteriaId)) if (!$PrivilegeCriteriaDTO) { throw "Error! The required parameter `PrivilegeCriteriaDTO` missing when calling putCustomPrivilegeCriteriaValue." } if ($LocalVarContentTypes.Contains('application/json-patch+json') -or ($PrivilegeCriteriaDTO -is [array])) { $LocalVarBodyParameter = $PrivilegeCriteriaDTO | ConvertTo-Json -AsArray -Depth 100 } else { $LocalVarBodyParameter = $PrivilegeCriteriaDTO | ForEach-Object { # Get array of names of object properties that can be cast to boolean TRUE # PSObject.Properties - https://msdn.microsoft.com/en-us/library/system.management.automation.psobject.properties.aspx $NonEmptyProperties = $_.psobject.Properties | Where-Object {$null -ne $_.Value} | Select-Object -ExpandProperty Name # Convert object to JSON with only non-empty properties $_ | Select-Object -Property $NonEmptyProperties | ConvertTo-Json -Depth 100 } } $LocalVarResult = Invoke-V2025ApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "PrivilegeCriteriaDTO" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } |