Api/GenericApi.ps1
|
# # SailPoint Identity Security API - Generic # Generic client for the SailPoint Identity Security versioned APIs. Use it to call any endpoint, in any version, by its path, for example `sources/v1` or `sources/v2/{sourceId}/provisioning-policies`, including endpoints that do not have a resource-specific client or documentation yet. The version is part of the path, so this client is not tied to one API version and the base URL has no version segment. # Version: any (set in the path) # Generated by OpenAPI Generator: https://openapi-generator.tech # <# .SYNOPSIS Generic DELETE request .DESCRIPTION Sends a DELETE request to any versioned API path. .PARAMETER Path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`. .PARAMETER XSailPointExperimental Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AnyType #> function Invoke-GenericDelete { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Path}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] $XSailPointExperimental, [Switch] $WithHttpInfo ) Process { 'Calling method: Invoke-GenericDelete' | 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 = '/{path}' if (!$Path) { throw "Error! The required parameter `Path` missing when calling genericDelete." } $GenericRequestPath = ConvertTo-GenericRequestPath -Path $Path $LocalVarUri = $GenericRequestPath.Uri foreach ($Key in $GenericRequestPath.Query.Keys) { $LocalVarQueryParameters[$Key] = $GenericRequestPath.Query[$Key] } if ($XSailPointExperimental) { $LocalVarHeaderParameters['X-SailPoint-Experimental'] = $XSailPointExperimental } $LocalVarResult = Invoke-ApiClient -Method 'DELETE' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AnyType" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Generic GET request .DESCRIPTION Sends a GET request to any versioned API path, for example `sources/v1/{id}/schemas` or `sources/v2/{sourceId}/provisioning-policies`. .PARAMETER Path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`. .PARAMETER Limit Max number of results to return. See [Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters) for more information. .PARAMETER Offset Offset into the full result set. Usually specified with *limit* to paginate through the results. .PARAMETER Count If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. .PARAMETER Filters Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters#filtering-results). .PARAMETER Sorters Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/docs/standard-collection-parameters#sorting-results). .PARAMETER XSailPointExperimental Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AnyType #> function Invoke-GenericGet { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Path}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Int32]] ${Limit}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Int32]] ${Offset}, [Parameter(Position = 3, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [System.Nullable[Boolean]] ${Count}, [Parameter(Position = 4, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Filters}, [Parameter(Position = 5, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Sorters}, [Parameter(Position = 6, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] $XSailPointExperimental, [Switch] $WithHttpInfo ) Process { 'Calling method: Invoke-GenericGet' | 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 = '/{path}' if (!$Path) { throw "Error! The required parameter `Path` missing when calling genericGet." } $GenericRequestPath = ConvertTo-GenericRequestPath -Path $Path $LocalVarUri = $GenericRequestPath.Uri foreach ($Key in $GenericRequestPath.Query.Keys) { $LocalVarQueryParameters[$Key] = $GenericRequestPath.Query[$Key] } if ($XSailPointExperimental) { $LocalVarHeaderParameters['X-SailPoint-Experimental'] = $XSailPointExperimental } if ($Limit) { $LocalVarQueryParameters['limit'] = $Limit } if ($Offset) { $LocalVarQueryParameters['offset'] = $Offset } if ($Count) { $LocalVarQueryParameters['count'] = $Count } if ($Filters) { $LocalVarQueryParameters['filters'] = $Filters } if ($Sorters) { $LocalVarQueryParameters['sorters'] = $Sorters } $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AnyType" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Generic PATCH request .DESCRIPTION Sends a PATCH request to any versioned API path. The body is a JSON Patch document (RFC 6902): a list of operations such as `[{""op"": ""replace"", ""path"": ""/description"", ""value"": ""New description""}]`. .PARAMETER Path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`. .PARAMETER XSailPointExperimental Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs. .PARAMETER RequestBody No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AnyType #> function Invoke-GenericPatch { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Path}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] $XSailPointExperimental, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [Object] ${RequestBody}, [Switch] $WithHttpInfo ) Process { 'Calling method: Invoke-GenericPatch' | 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-patch+json') $LocalVarUri = '/{path}' if (!$Path) { throw "Error! The required parameter `Path` missing when calling genericPatch." } $GenericRequestPath = ConvertTo-GenericRequestPath -Path $Path $LocalVarUri = $GenericRequestPath.Uri foreach ($Key in $GenericRequestPath.Query.Keys) { $LocalVarQueryParameters[$Key] = $GenericRequestPath.Query[$Key] } if ($XSailPointExperimental) { $LocalVarHeaderParameters['X-SailPoint-Experimental'] = $XSailPointExperimental } if ($null -ne $RequestBody) { $LocalVarBodyParameter = ConvertTo-Json -InputObject $RequestBody -Depth 100 } $LocalVarResult = Invoke-ApiClient -Method 'PATCH' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AnyType" ` -IsBodyNullable $true if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Generic POST request .DESCRIPTION Sends a POST request with a JSON body to any versioned API path. .PARAMETER Path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`. .PARAMETER XSailPointExperimental Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs. .PARAMETER RequestBody No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AnyType #> function Invoke-GenericPost { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Path}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] $XSailPointExperimental, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [Object] ${RequestBody}, [Switch] $WithHttpInfo ) Process { 'Calling method: Invoke-GenericPost' | 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 = '/{path}' if (!$Path) { throw "Error! The required parameter `Path` missing when calling genericPost." } $GenericRequestPath = ConvertTo-GenericRequestPath -Path $Path $LocalVarUri = $GenericRequestPath.Uri foreach ($Key in $GenericRequestPath.Query.Keys) { $LocalVarQueryParameters[$Key] = $GenericRequestPath.Query[$Key] } if ($XSailPointExperimental) { $LocalVarHeaderParameters['X-SailPoint-Experimental'] = $XSailPointExperimental } if ($null -ne $RequestBody) { $LocalVarBodyParameter = ConvertTo-Json -InputObject $RequestBody -Depth 100 } $LocalVarResult = Invoke-ApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AnyType" ` -IsBodyNullable $true if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Generic PUT request .DESCRIPTION Sends a PUT request with a JSON body to any versioned API path. .PARAMETER Path API path relative to the tenant base URL, including the API version, for example `accounts/v1`, `sources/v1/2c9180835d2e5168015d32f890ca1581` or `sources/v2/2c9180835d2e5168015d32f890ca1581/provisioning-policies`. Use whichever version the endpoint has. A leading slash is optional. Slashes separate path segments, and the SDK URL-encodes each segment, so pass the segments unencoded. Anything after a `?` is sent as query parameters, for example `accounts/v1?detailLevel=SLIM`. .PARAMETER XSailPointExperimental Set this header to `true` to call an experimental API. The SDK configuration must also enable experimental APIs. .PARAMETER RequestBody No description available. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS AnyType #> function Invoke-GenericPut { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Path}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] $XSailPointExperimental, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [Object] ${RequestBody}, [Switch] $WithHttpInfo ) Process { 'Calling method: Invoke-GenericPut' | 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 = '/{path}' if (!$Path) { throw "Error! The required parameter `Path` missing when calling genericPut." } $GenericRequestPath = ConvertTo-GenericRequestPath -Path $Path $LocalVarUri = $GenericRequestPath.Uri foreach ($Key in $GenericRequestPath.Query.Keys) { $LocalVarQueryParameters[$Key] = $GenericRequestPath.Query[$Key] } if ($XSailPointExperimental) { $LocalVarHeaderParameters['X-SailPoint-Experimental'] = $XSailPointExperimental } if ($null -ne $RequestBody) { $LocalVarBodyParameter = ConvertTo-Json -InputObject $RequestBody -Depth 100 } $LocalVarResult = Invoke-ApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "AnyType" ` -IsBodyNullable $true if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } |