mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
Update to powershell SDK docs: 14132734151
This commit is contained in:
developer-relations-sp
@@ -91,7 +91,7 @@ Method | HTTP request | Description
|
||||
[**Get-V2024ProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType
|
||||
[**Get-V2024Source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID
|
||||
[**Get-V2024SourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config
|
||||
[**Get-V2024SourceConfig**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language translations
|
||||
[**Get-V2024SourceConfig**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language-translations
|
||||
[**Get-V2024SourceConnections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID
|
||||
[**Get-V2024SourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration
|
||||
[**Get-V2024SourceHealth**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id
|
||||
@@ -106,7 +106,6 @@ Method | HTTP request | Description
|
||||
[**Import-V2024UncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts
|
||||
[**Get-V2024ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies
|
||||
[**Get-V2024Sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow.
|
||||
[**Receive-V2024ResourceObjects**](#peek-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects
|
||||
[**Ping-V2024Cluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector
|
||||
[**Send-V2024CorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update Source Correlation Configuration
|
||||
[**Send-V2024NativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration
|
||||
@@ -114,6 +113,7 @@ Method | HTTP request | Description
|
||||
[**Send-V2024Source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full)
|
||||
[**Send-V2024SourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config
|
||||
[**Send-V2024SourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full)
|
||||
[**Search-V2024ResourceObjects**](#search-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects
|
||||
[**Sync-V2024AttributesForSource**](#sync-attributes-for-source) | **POST** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes.
|
||||
[**Test-V2024SourceConfiguration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector
|
||||
[**Test-V2024SourceConnection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector.
|
||||
@@ -1115,9 +1115,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-source-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Looks up and returns the source config for the requested source id after populating the source config values and applying language translations.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-config)
|
||||
@@ -1126,7 +1123,6 @@ Looks up and returns the source config for the requested source id after populat
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | Id | **String** | True | The Source id
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en""
|
||||
|
||||
### Return type
|
||||
@@ -1136,6 +1132,7 @@ Path | Id | **String** | True | The Source id
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | A Connector Detail object | ConnectorDetail
|
||||
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. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
@@ -1148,17 +1145,16 @@ Code | Description | Data Type
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Id = "MyId" # String | The Source id
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$Id = "cef3ee201db947c5912551015ba0c679" # String | The Source id
|
||||
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional)
|
||||
|
||||
# Gets source config with language translations
|
||||
# Gets source config with language-translations
|
||||
|
||||
try {
|
||||
Get-V2024SourceConfig -Id $Id -XSailPointExperimental $XSailPointExperimental
|
||||
Get-V2024SourceConfig -Id $Id
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024SourceConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -Locale $Locale
|
||||
# Get-V2024SourceConfig -Id $Id -Locale $Locale
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConfig"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -1879,67 +1875,7 @@ try {
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## peek-resource-objects
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Retrieves a sample of data returned from account and group aggregation requests.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/peek-resource-objects)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | SourceId | **String** | True | The ID of the Source
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | ResourceObjectsRequest | [**ResourceObjectsRequest**](../models/resource-objects-request) | True |
|
||||
|
||||
### Return type
|
||||
[**ResourceObjectsResponse**](../models/resource-objects-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of resource objects that was fetched from the source connector. | ResourceObjectsResponse
|
||||
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. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$ResourceObjectsRequest = @"{
|
||||
"maxCount" : 100,
|
||||
"objectType" : "group"
|
||||
}"@
|
||||
|
||||
# Peek source connector's resource objects
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest
|
||||
Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -ResourceObjectsRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -ResourceObjectsRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-V2024ResourceObjects"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## ping-cluster
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This endpoint validates that the cluster being used by the source is reachable from IdentityNow.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/ping-cluster)
|
||||
@@ -1948,7 +1884,6 @@ This endpoint validates that the cluster being used by the source is reachable f
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | SourceId | **String** | True | The ID of the Source
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**StatusResponse**](../models/status-response)
|
||||
@@ -1971,15 +1906,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Ping cluster for source connector
|
||||
|
||||
try {
|
||||
Ping-V2024Cluster -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental
|
||||
Ping-V2024Cluster -SourceId $SourceId
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Ping-V2024Cluster -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental
|
||||
# Ping-V2024Cluster -SourceId $SourceId
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2024Cluster"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -2518,6 +2452,58 @@ try {
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## search-resource-objects
|
||||
Retrieves a sample of data returned from account and group aggregation requests.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-resource-objects)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | SourceId | **String** | True | The ID of the Source
|
||||
Body | ResourceObjectsRequest | [**ResourceObjectsRequest**](../models/resource-objects-request) | True |
|
||||
|
||||
### Return type
|
||||
[**ResourceObjectsResponse**](../models/resource-objects-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | List of resource objects that was fetched from the source connector. | ResourceObjectsResponse
|
||||
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. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | 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. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source
|
||||
$ResourceObjectsRequest = @"{
|
||||
"maxCount" : 100,
|
||||
"objectType" : "group"
|
||||
}"@
|
||||
|
||||
# Peek source connector's resource objects
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest
|
||||
Search-V2024ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Search-V2024ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024ResourceObjects"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## sync-attributes-for-source
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
@@ -2570,9 +2556,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## test-source-configuration
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This endpoint performs a more detailed validation of the source''s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-source-configuration)
|
||||
@@ -2581,7 +2564,6 @@ This endpoint performs a more detailed validation of the source''s configuration
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | SourceId | **String** | True | The ID of the Source
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**StatusResponse**](../models/status-response)
|
||||
@@ -2604,15 +2586,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Test configuration for source connector
|
||||
|
||||
try {
|
||||
Test-V2024SourceConfiguration -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental
|
||||
Test-V2024SourceConfiguration -SourceId $SourceId
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Test-V2024SourceConfiguration -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental
|
||||
# Test-V2024SourceConfiguration -SourceId $SourceId
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConfiguration"
|
||||
Write-Host $_.ErrorDetails
|
||||
@@ -2621,9 +2602,6 @@ try {
|
||||
[[Back to top]](#)
|
||||
|
||||
## test-source-connection
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-source-connection)
|
||||
@@ -2632,7 +2610,6 @@ This endpoint validates that the configured credentials are valid and will prope
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | SourceId | **String** | True | The ID of the Source.
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**StatusResponse**](../models/status-response)
|
||||
@@ -2655,15 +2632,14 @@ Code | Description | Data Type
|
||||
### Example
|
||||
```powershell
|
||||
$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source.
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Check connection for source connector.
|
||||
|
||||
try {
|
||||
Test-V2024SourceConnection -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental
|
||||
Test-V2024SourceConnection -SourceId $SourceId
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Test-V2024SourceConnection -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental
|
||||
# Test-V2024SourceConnection -SourceId $SourceId
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnection"
|
||||
Write-Host $_.ErrorDetails
|
||||
|
||||
Reference in New Issue
Block a user