developer.sailpoint.com/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
beta-application-discovery	ApplicationDiscovery	ApplicationDiscovery	ApplicationDiscovery	powershellsdk	powershell PowerShell sdk ApplicationDiscovery BetaApplicationDiscovery	/tools/sdk/powershell/beta/methods/application-discovery	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.

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method	HTTP request	Description
Get-BetaDiscoveredApplicationByID	GET /discovered-applications/{id}	Get discovered application by id
Get-BetaDiscoveredApplications	GET /discovered-applications	Retrieve discovered applications for tenant
Get-BetaManualDiscoverApplicationsCsvTemplate	GET /manual-discover-applications-template	Download csv template for discovery
Update-BetaDiscoveredApplicationByID	PATCH /discovered-applications/{id}	Patch discovered application by id
Send-BetaManualDiscoverApplicationsCsvTemplate	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.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	Discovered application's ID.

Return type

(empty response body)

Responses

Code	Description	Data Type
200	Returns the discovered application, along with its associated sources.
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessModelMetadataAttribute401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

$Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID.

# Get discovered application by id

try {
    Get-BetaDiscoveredApplicationByID -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-BetaDiscoveredApplicationByID -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplicationByID"
    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.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Offset	Int32	(optional) (default to 0)	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query	Detail	String	(optional)	Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior.
Query	Filter	String	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters 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
Query	Sorters	String	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, description, discoveredAt, discoverySource

Return type

GetDiscoveredApplications200ResponseInner[]

Responses

Code	Description	Data Type
200	List of discovered applications. By default, the API returns a list of SLIM discovered applications.	GetDiscoveredApplications200ResponseInner[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessModelMetadataAttribute401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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 
    
    # Below is a request that includes all optional parameters
    # Get-BetaDiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplications"
    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.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description

Return type

ManualDiscoverApplicationsTemplate

Responses

Code	Description	Data Type
200	A CSV file download was successful.	ManualDiscoverApplicationsTemplate
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessModelMetadataAttribute401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
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

# Download csv template for discovery

try {
    Get-BetaManualDiscoverApplicationsCsvTemplate 
    
    # Below is a request that includes all optional parameters
    # Get-BetaManualDiscoverApplicationsCsvTemplate  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManualDiscoverApplicationsCsvTemplate"
    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 syntax. You can patch these fields: - associatedSources - dismissed

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	Discovered application's ID.
Body	JsonPatchOperations	[]JsonPatchOperations	(optional)

Return type

(empty response body)

Responses

Code	Description	Data Type
200	Returns the single patched discovered application.
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessModelMetadataAttribute401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
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

$Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID.
 $JsonPatchOperations = @"{
  "op" : "replace",
  "path" : "/dismissed",
  "value" : true
}"@ # JsonPatchOperations[] |  (optional)
 

# Patch discovered application by id

try {
    Update-BetaDiscoveredApplicationByID -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Update-BetaDiscoveredApplicationByID -Id $Id -JsonPatchOperations $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID"
    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.

API Spec

Parameters

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

Code	Description	Data Type
200	The CSV has been successfully processed.
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessModelMetadataAttribute401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

Example

$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 -File $File 
    
    # Below is a request that includes all optional parameters
    # Send-BetaManualDiscoverApplicationsCsvTemplate -File $File  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate"
    Write-Host $_.ErrorDetails
}

[Back to top]