Api/MachineAccountRecommendationApi.ps1
|
# # Identity Security Cloud API - Machine Account Recommendation # 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: v1 # Generated by OpenAPI Generator: https://openapi-generator.tech # <# .SYNOPSIS Get machine account recommendation .DESCRIPTION This API returns the machine account discovery recommendation for an account. The recommendation states whether the account is likely a machine account and lists the reasons that contributed to it. When no recommendation exists for the account, this API returns `200` with an empty response body. When machine account discovery is not enabled for the tenant, this API returns `404`. .PARAMETER XSailPointExperimental Use this header to enable this experimental API. .PARAMETER Id Account ID. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS MachineAccountRecommendation #> function Get-MachineAccountRecommendationV1 { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] $XSailPointExperimental = "true", [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${Id}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-MachineAccountRecommendationV1' | 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 = '/accounts/v1/{id}/recommendation' if (!$Id) { throw "Error! The required parameter `Id` missing when calling getMachineAccountRecommendationV1." } $LocalVarUri = $LocalVarUri.replace('{id}', [System.Web.HTTPUtility]::UrlEncode($Id)) if (!$XSailPointExperimental) { throw "Error! The required parameter `XSailPointExperimental` missing when calling getMachineAccountRecommendationV1." } $LocalVarHeaderParameters['X-SailPoint-Experimental'] = $XSailPointExperimental $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "MachineAccountRecommendation" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS List machine account discovery reasons .DESCRIPTION This API returns the reasons that machine account discovery can report for a recommendation. Each reason has an ID and a readable message. Use this list to show a message for each reason in a machine account recommendation. Messages are localized. Send the `Accept-Language` header to choose a language. When the requested language is not available, messages are returned in the default language. The reasons are returned in the order defined by the catalog. When the catalog does not define an order, the reasons are sorted by ID. When machine account discovery is not enabled for the tenant, this API returns `404`. .PARAMETER XSailPointExperimental Use this header to enable this experimental API. .PARAMETER AcceptLanguage Preferred language for the reason messages. .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS MachineAccountDiscoveryReason[] #> function Get-MachineAccountDiscoveryReasonsV1 { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] $XSailPointExperimental = "true", [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] $AcceptLanguage = "en", [Switch] $WithHttpInfo ) Process { 'Calling method: Get-MachineAccountDiscoveryReasonsV1' | 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 = '/ai-recommendations/v1/reasons/machine-account-discovery' if (!$XSailPointExperimental) { throw "Error! The required parameter `XSailPointExperimental` missing when calling listMachineAccountDiscoveryReasonsV1." } $LocalVarHeaderParameters['X-SailPoint-Experimental'] = $XSailPointExperimental if ($AcceptLanguage) { $LocalVarHeaderParameters['Accept-Language'] = $AcceptLanguage } $LocalVarResult = Invoke-ApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "MachineAccountDiscoveryReason[]" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } |