mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Update to powershell SDK docs: 13122455471
This commit is contained in:
developer-relations-sp
@@ -1,3 +1,4 @@
|
||||
|
||||
---
|
||||
id: v2024-apps
|
||||
title: Apps
|
||||
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v2024/methods/apps
|
||||
tags: ['SDK', 'Software Development Kit', 'Apps', 'V2024Apps']
|
||||
---
|
||||
|
||||
|
||||
# Apps
|
||||
Use this API to implement source application functionality.
|
||||
With this functionality in place, you can create, customize, and manage applications within sources.
|
||||
@@ -35,9 +35,7 @@ Method | HTTP request | Description
|
||||
[**Update-V2024UserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID
|
||||
[**Update-V2024SourceAppsInBulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps
|
||||
|
||||
|
||||
## create-source-app
|
||||
|
||||
This endpoint creates a source app using the given source app payload
|
||||
|
||||
### Parameters
|
||||
@@ -47,7 +45,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | SourceAppCreateDto | [**SourceAppCreateDto**](../models/source-app-create-dto) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**SourceApp**](../models/source-app)
|
||||
|
||||
### Responses
|
||||
@@ -61,7 +58,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -78,7 +74,9 @@ $SourceAppCreateDto = @"{
|
||||
},
|
||||
"matchAllAccounts" : true
|
||||
}"@
|
||||
|
||||
# Create source app
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto
|
||||
New-V2024SourceApp-V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result
|
||||
@@ -90,11 +88,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-access-profiles-from-source-app-by-bulk
|
||||
|
||||
This API returns the final list of access profiles for the specified source app after removing
|
||||
|
||||
### Parameters
|
||||
@@ -106,7 +101,6 @@ Path | Id | **String** | True | ID of the source app
|
||||
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccessProfileDetails[]**](../models/access-profile-details)
|
||||
|
||||
### Responses
|
||||
@@ -120,7 +114,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -129,10 +122,12 @@ Code | Description | Data Type
|
||||
$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$RequestBody = "MyRequestBody" # String[] |
|
||||
$RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@
|
||||
|
||||
$RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@ # String[] |
|
||||
|
||||
$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)
|
||||
|
||||
# Bulk remove access profiles from the specified source app
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
|
||||
Remove-V2024AccessProfilesFromSourceAppByBulk-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result
|
||||
@@ -144,11 +139,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-source-app
|
||||
|
||||
Use this API to delete a specific source app
|
||||
|
||||
### Parameters
|
||||
@@ -158,7 +150,6 @@ Path | Id | **String** | True | source app ID.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
|
||||
[**SourceApp**](../models/source-app)
|
||||
|
||||
### Responses
|
||||
@@ -172,7 +163,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
|
||||
|
||||
@@ -180,7 +170,9 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Delete source app by ID
|
||||
|
||||
try {
|
||||
Remove-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -191,11 +183,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-source-app
|
||||
|
||||
This API returns a source app by its ID.
|
||||
|
||||
### Parameters
|
||||
@@ -205,7 +194,6 @@ Path | Id | **String** | True | ID of the source app
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
|
||||
[**SourceApp**](../models/source-app)
|
||||
|
||||
### Responses
|
||||
@@ -220,7 +208,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
|
||||
|
||||
@@ -228,7 +215,9 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Get source app by ID
|
||||
|
||||
try {
|
||||
Get-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -239,11 +228,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-access-profiles-for-source-app
|
||||
|
||||
This API returns the list of access profiles for the specified source app
|
||||
|
||||
### Parameters
|
||||
@@ -256,7 +242,6 @@ Path | Id | **String** | True | ID of the source app
|
||||
Query | Filters | **String** | (optional) | 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: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
|
||||
|
||||
### Return type
|
||||
|
||||
[**AccessProfileDetails[]**](../models/access-profile-details)
|
||||
|
||||
### Responses
|
||||
@@ -270,7 +255,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
|
||||
|
||||
@@ -281,7 +265,9 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
|
||||
$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)
|
||||
$Filters = 'name eq "developer access profile"' # 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: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional)
|
||||
|
||||
# List access profiles for the specified source app
|
||||
|
||||
try {
|
||||
Get-V2024AccessProfilesForSourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -292,11 +278,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-all-source-app
|
||||
|
||||
This API returns the list of all source apps for the org.
|
||||
|
||||
### Parameters
|
||||
@@ -310,7 +293,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Filters | **String** | (optional) | 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq*
|
||||
|
||||
### Return type
|
||||
|
||||
[**SourceApp[]**](../models/source-app)
|
||||
|
||||
### Responses
|
||||
@@ -324,7 +306,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
|
||||
|
||||
@@ -336,7 +317,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
|
||||
$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)
|
||||
$Sorters = "name,-modified" # 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: **id, name, created, modified, owner.id, accountSource.id** (optional)
|
||||
$Filters = 'enabled eq true' # 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional)
|
||||
|
||||
# List all source apps
|
||||
|
||||
try {
|
||||
Get-V2024AllSourceApp-V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -347,11 +330,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-all-user-apps
|
||||
|
||||
This API returns the list of all user apps with specified filters.
|
||||
This API must be used with **filters** query parameter.
|
||||
|
||||
@@ -365,7 +345,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
|
||||
[**UserApp[]**](../models/user-app)
|
||||
|
||||
### Responses
|
||||
@@ -379,7 +358,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
|
||||
|
||||
@@ -390,7 +368,9 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
|
||||
$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)
|
||||
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
$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)
|
||||
|
||||
# List all user apps
|
||||
|
||||
try {
|
||||
Get-V2024AllUserApps-V2024Filters $Filters -V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -401,11 +381,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-assigned-source-app
|
||||
|
||||
This API returns the list of source apps assigned for logged in user.
|
||||
|
||||
### Parameters
|
||||
@@ -419,7 +396,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Filters | **String** | (optional) | 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in*
|
||||
|
||||
### Return type
|
||||
|
||||
[**SourceApp[]**](../models/source-app)
|
||||
|
||||
### Responses
|
||||
@@ -433,7 +409,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
|
||||
|
||||
@@ -445,7 +420,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
|
||||
$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)
|
||||
$Sorters = "name,-modified" # 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: **id, name, created, modified, accountSource.id** (optional)
|
||||
$Filters = 'name eq "source app name"' # 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional)
|
||||
|
||||
# List assigned source apps
|
||||
|
||||
try {
|
||||
Get-V2024AssignedSourceApp-V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -456,11 +433,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-available-accounts-for-user-app
|
||||
|
||||
This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user.
|
||||
|
||||
### Parameters
|
||||
@@ -472,7 +446,6 @@ Path | Id | **String** | True | ID of the user app
|
||||
Query | Count | **Boolean** | (optional) (default to $false) | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
|
||||
[**AppAccountDetails[]**](../models/app-account-details)
|
||||
|
||||
### Responses
|
||||
@@ -486,7 +459,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
|
||||
|
||||
@@ -496,7 +468,9 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$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)
|
||||
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
|
||||
# List available accounts for user app
|
||||
|
||||
try {
|
||||
Get-V2024AvailableAccountsForUserApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -507,11 +481,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-available-source-apps
|
||||
|
||||
This API returns the list of source apps available for access request.
|
||||
|
||||
### Parameters
|
||||
@@ -525,7 +496,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Filters | **String** | (optional) | 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in*
|
||||
|
||||
### Return type
|
||||
|
||||
[**SourceApp[]**](../models/source-app)
|
||||
|
||||
### Responses
|
||||
@@ -539,7 +509,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
|
||||
|
||||
@@ -551,7 +520,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
|
||||
$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)
|
||||
$Sorters = "name,-modified" # 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: **id, name, created, modified, owner.id, accountSource.id** (optional)
|
||||
$Filters = 'name eq "source app name"' # 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: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional)
|
||||
|
||||
# List available source apps
|
||||
|
||||
try {
|
||||
Get-V2024AvailableSourceApps-V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -562,11 +533,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-owned-user-apps
|
||||
|
||||
This API returns the list of user apps assigned to logged in user
|
||||
|
||||
### Parameters
|
||||
@@ -579,7 +547,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | Filters | **String** | (optional) | 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: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
|
||||
|
||||
### Return type
|
||||
|
||||
[**UserApp[]**](../models/user-app)
|
||||
|
||||
### Responses
|
||||
@@ -593,7 +560,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
|
||||
|
||||
@@ -604,7 +570,9 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
|
||||
$Count = $true # Boolean | 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. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
|
||||
$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)
|
||||
$Filters = 'name eq "user app name"' # 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: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional)
|
||||
|
||||
# List owned user apps
|
||||
|
||||
try {
|
||||
Get-V2024OwnedUserApps-V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -615,11 +583,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-source-app
|
||||
|
||||
This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
||||
The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**.
|
||||
Name, description and owner can't be empty or null.
|
||||
@@ -632,7 +597,6 @@ Path | Id | **String** | True | ID of the source app to patch
|
||||
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
|
||||
|
||||
### Return type
|
||||
|
||||
[**SourceAppPatchDto**](../models/source-app-patch-dto)
|
||||
|
||||
### Responses
|
||||
@@ -647,7 +611,6 @@ 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
|
||||
|
||||
@@ -655,14 +618,15 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
# JsonPatchOperation[] | (optional)
|
||||
$JsonPatchOperation = @"{
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
}"@
|
||||
}"@ # JsonPatchOperation[] | (optional)
|
||||
|
||||
|
||||
# Patch source app by ID
|
||||
|
||||
try {
|
||||
Update-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -673,11 +637,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-user-app
|
||||
|
||||
This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
||||
The following fields are patchable: **account**
|
||||
|
||||
@@ -689,7 +650,6 @@ Path | Id | **String** | True | ID of the user app to patch
|
||||
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
|
||||
|
||||
### Return type
|
||||
|
||||
[**UserApp**](../models/user-app)
|
||||
|
||||
### Responses
|
||||
@@ -704,7 +664,6 @@ 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
|
||||
|
||||
@@ -712,14 +671,15 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
# JsonPatchOperation[] | (optional)
|
||||
$JsonPatchOperation = @"{
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
}"@
|
||||
}"@ # JsonPatchOperation[] | (optional)
|
||||
|
||||
|
||||
# Patch user app by ID
|
||||
|
||||
try {
|
||||
Update-V2024UserApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -730,11 +690,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-source-apps-in-bulk
|
||||
|
||||
This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch.
|
||||
The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**.
|
||||
Name, description and owner can't be empty or null.
|
||||
@@ -746,7 +703,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | SourceAppBulkUpdateRequest | [**SourceAppBulkUpdateRequest**](../models/source-app-bulk-update-request) | (optional) |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
@@ -761,7 +717,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -780,7 +735,9 @@ $SourceAppBulkUpdateRequest = @"{
|
||||
"value" : false
|
||||
} ]
|
||||
}"@
|
||||
|
||||
# Bulk update source apps
|
||||
|
||||
try {
|
||||
Update-V2024SourceAppsInBulk-V2024XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
@@ -791,7 +748,4 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user