LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md
View File

@@ -1,3 +1,4 @@
---
id: beta-application-discovery
title: ApplicationDiscovery
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/application-discovery
tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery', 'BetaApplicationDiscovery']
---
# ApplicationDiscovery
Use this API to implement application discovery functionality.
With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names.
@@ -26,9 +26,7 @@ Method | HTTP request | Description
[**Update-BetaDiscoveredApplicationByID**](#patch-discovered-application-by-id) | **PATCH** `/discovered-applications/{id}` | Patch Discovered Application by ID
[**Send-BetaManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications
## get-discovered-application-by-id
Get the discovered application, along with with its associated sources, based on the provided ID.
@@ -38,7 +36,6 @@ Param Type | Name | Data Type | Required | Description
Path | Id | **String** | True | Discovered application's ID.
### Return type
(empty response body)
### Responses
@@ -52,14 +49,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID.
# Get Discovered Application by ID
try {
Get-BetaDiscoveredApplicationByID-BetaId $Id
@@ -70,11 +68,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-discovered-applications
Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors.
@@ -88,7 +83,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource**
### Return type
[**GetDiscoveredApplications200ResponseInner[]**](../models/get-discovered-applications200-response-inner)
### Responses
@@ -102,7 +96,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -113,7 +106,9 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional)
$Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | 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: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional)
# Retrieve discovered applications for tenant
try {
Get-BetaDiscoveredApplications
@@ -124,11 +119,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-manual-discover-applications-csv-template
Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'.
The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint.
@@ -139,7 +131,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
### Return type
[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template)
### Responses
@@ -153,13 +144,14 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: text/csv, application/json
### Example
```powershell
# Download CSV Template for Discovery
try {
Get-BetaManualDiscoverApplicationsCsvTemplate
@@ -170,11 +162,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## patch-discovered-application-by-id
Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
You can patch these fields: - **associatedSources** - **dismissed**
@@ -185,7 +174,6 @@ Path | Id | **String** | True | Discovered application's ID.
Body | JsonPatchOperations | [**[]JsonPatchOperations**](../models/json-patch-operations) | (optional) |
### Return type
(empty response body)
### Responses
@@ -199,21 +187,21 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json-patch+json
- **Accept**: application/json
### Example
```powershell
$Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID.
# JsonPatchOperations[] | (optional)
$JsonPatchOperations = @"{
"op" : "replace",
"path" : "/dismissed",
"value" : true
}"@
}"@ # JsonPatchOperations[] | (optional)
# Patch Discovered Application by ID
try {
Update-BetaDiscoveredApplicationByID-BetaId $Id
@@ -224,11 +212,8 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-manual-discover-applications-csv-template
Upload a CSV file with application data for manual correlation to specific ISC connectors.
If a suitable ISC connector is unavailable, the system will recommend generic connectors instead.
@@ -238,7 +223,6 @@ Param Type | Name | Data Type | Required | Description
| File | **System.IO.FileInfo** | True | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
### Return type
(empty response body)
### Responses
@@ -252,14 +236,15 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
### Example
```powershell
$File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
# Upload CSV to Discover Applications
try {
Send-BetaManualDiscoverApplicationsCsvTemplate-BetaFile $File
@@ -270,7 +255,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)