mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Update to powershell SDK docs: 13842472521
This commit is contained in:
developer-relations-sp
@@ -92,6 +92,7 @@ Method | HTTP request | Description
|
||||
[**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-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
|
||||
[**Get-V2024SourceSchedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type
|
||||
@@ -1165,6 +1166,52 @@ try {
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-source-connections
|
||||
Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC).
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-connections)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | SourceId | **String** | True | Source ID.
|
||||
|
||||
### Return type
|
||||
[**SourceConnectionsDto**](../models/source-connections-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Source Connections object. | SourceConnectionsDto
|
||||
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**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
|
||||
|
||||
# Get Source Connections by ID
|
||||
|
||||
try {
|
||||
Get-V2024SourceConnections -SourceId $SourceId
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024SourceConnections -SourceId $SourceId
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConnections"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-source-entitlement-request-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.
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
id: v2024-dependant-app-connections
|
||||
title: DependantAppConnections
|
||||
pagination_label: DependantAppConnections
|
||||
sidebar_label: DependantAppConnections
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'DependantAppConnections', 'V2024DependantAppConnections']
|
||||
slug: /tools/sdk/powershell/v2024/models/dependant-app-connections
|
||||
tags: ['SDK', 'Software Development Kit', 'DependantAppConnections', 'V2024DependantAppConnections']
|
||||
---
|
||||
|
||||
|
||||
# DependantAppConnections
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CloudAppId** | **String** | Id of the connected Application | [optional]
|
||||
**Description** | **String** | Description of the connected Application | [optional]
|
||||
**Enabled** | **Boolean** | Is the Application enabled | [optional] [default to $true]
|
||||
**ProvisionRequestEnabled** | **Boolean** | Is Provisioning enabled for connected Application | [optional] [default to $true]
|
||||
**AccountSource** | [**DependantAppConnectionsAccountSource**](dependant-app-connections-account-source) | | [optional]
|
||||
**LauncherCount** | **Int64** | The amount of launchers for connected Application (long type) | [optional]
|
||||
**MatchAllAccount** | **Boolean** | Is Provisioning enabled for connected Application | [optional] [default to $false]
|
||||
**Owner** | [**[]BaseReferenceDto**](base-reference-dto) | The owner of the connected Application | [optional]
|
||||
**AppCenterEnabled** | **Boolean** | Is App Center enabled for connected Application | [optional] [default to $false]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$DependantAppConnections = Initialize-PSSailpoint.V2024DependantAppConnections -CloudAppId 9e3cdd80edf84f119327df8bbd5bb5ac `
|
||||
-Description This is a Sailpoint application `
|
||||
-Enabled true `
|
||||
-ProvisionRequestEnabled true `
|
||||
-AccountSource null `
|
||||
-LauncherCount 100 `
|
||||
-MatchAllAccount true `
|
||||
-Owner null `
|
||||
-AppCenterEnabled false
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$DependantAppConnections | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-dependant-app-connections-account-source
|
||||
title: DependantAppConnectionsAccountSource
|
||||
pagination_label: DependantAppConnectionsAccountSource
|
||||
sidebar_label: DependantAppConnectionsAccountSource
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'DependantAppConnectionsAccountSource', 'V2024DependantAppConnectionsAccountSource']
|
||||
slug: /tools/sdk/powershell/v2024/models/dependant-app-connections-account-source
|
||||
tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSource', 'V2024DependantAppConnectionsAccountSource']
|
||||
---
|
||||
|
||||
|
||||
# DependantAppConnectionsAccountSource
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**UseForPasswordManagement** | **Boolean** | Use this Account Source for password management | [optional] [default to $false]
|
||||
**PasswordPolicies** | [**[]DependantAppConnectionsAccountSourcePasswordPoliciesInner**](dependant-app-connections-account-source-password-policies-inner) | A list of Password Policies for this Account Source | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$DependantAppConnectionsAccountSource = Initialize-PSSailpoint.V2024DependantAppConnectionsAccountSource -UseForPasswordManagement false `
|
||||
-PasswordPolicies null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$DependantAppConnectionsAccountSource | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-dependant-app-connections-account-source-password-policies-inner
|
||||
title: DependantAppConnectionsAccountSourcePasswordPoliciesInner
|
||||
pagination_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner
|
||||
sidebar_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'V2024DependantAppConnectionsAccountSourcePasswordPoliciesInner']
|
||||
slug: /tools/sdk/powershell/v2024/models/dependant-app-connections-account-source-password-policies-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'V2024DependantAppConnectionsAccountSourcePasswordPoliciesInner']
|
||||
---
|
||||
|
||||
|
||||
# DependantAppConnectionsAccountSourcePasswordPoliciesInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **String** | DTO type | [optional]
|
||||
**Id** | **String** | ID of the object to which this reference applies | [optional]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$DependantAppConnectionsAccountSourcePasswordPoliciesInner = Initialize-PSSailpoint.V2024DependantAppConnectionsAccountSourcePasswordPoliciesInner -Type PASSWORD_POLICY `
|
||||
-Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name Policy ODS
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$DependantAppConnectionsAccountSourcePasswordPoliciesInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-dependant-connections-missing-dto
|
||||
title: DependantConnectionsMissingDto
|
||||
pagination_label: DependantConnectionsMissingDto
|
||||
sidebar_label: DependantConnectionsMissingDto
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'DependantConnectionsMissingDto', 'V2024DependantConnectionsMissingDto']
|
||||
slug: /tools/sdk/powershell/v2024/models/dependant-connections-missing-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'DependantConnectionsMissingDto', 'V2024DependantConnectionsMissingDto']
|
||||
---
|
||||
|
||||
|
||||
# DependantConnectionsMissingDto
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**DependencyType** | **Enum** [ "identityProfiles", "credentialProfiles", "mappingProfiles", "sourceAttributes", "dependantCustomTransforms", "dependantApps" ] | The type of dependency type that is missing in the SourceConnections | [optional]
|
||||
**Reason** | **String** | The reason why this dependency is missing | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$DependantConnectionsMissingDto = Initialize-PSSailpoint.V2024DependantConnectionsMissingDto -DependencyType dependantApps `
|
||||
-Reason If there was an error retrieving any dependencies, it would lbe listed here
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$DependantConnectionsMissingDto | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-identity-profiles-connections
|
||||
title: IdentityProfilesConnections
|
||||
pagination_label: IdentityProfilesConnections
|
||||
sidebar_label: IdentityProfilesConnections
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfilesConnections', 'V2024IdentityProfilesConnections']
|
||||
slug: /tools/sdk/powershell/v2024/models/identity-profiles-connections
|
||||
tags: ['SDK', 'Software Development Kit', 'IdentityProfilesConnections', 'V2024IdentityProfilesConnections']
|
||||
---
|
||||
|
||||
|
||||
# IdentityProfilesConnections
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | ID of the IdentityProfile this reference applies | [optional]
|
||||
**Name** | **String** | Human-readable display name of the IdentityProfile to which this reference applies | [optional]
|
||||
**IdentityCount** | **Int64** | The Number of Identities managed by this IdentityProfile | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$IdentityProfilesConnections = Initialize-PSSailpoint.V2024IdentityProfilesConnections -Id 76cfddb62818416f816bc494410f46c4 `
|
||||
-Name ODS-Identity-Profile `
|
||||
-IdentityCount 100
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$IdentityProfilesConnections | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
id: v2024-source-connections-dto
|
||||
title: SourceConnectionsDto
|
||||
pagination_label: SourceConnectionsDto
|
||||
sidebar_label: SourceConnectionsDto
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'SourceConnectionsDto', 'V2024SourceConnectionsDto']
|
||||
slug: /tools/sdk/powershell/v2024/models/source-connections-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'SourceConnectionsDto', 'V2024SourceConnectionsDto']
|
||||
---
|
||||
|
||||
|
||||
# SourceConnectionsDto
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IdentityProfiles** | [**[]IdentityProfilesConnections**](identity-profiles-connections) | The IdentityProfile attached to this source | [optional]
|
||||
**CredentialProfiles** | **[]String** | Name of the CredentialProfile attached to this source | [optional]
|
||||
**SourceAttributes** | **[]String** | The attributes attached to this source | [optional]
|
||||
**MappingProfiles** | **[]String** | The profiles attached to this source | [optional]
|
||||
**DependentCustomTransforms** | [**[]TransformRead**](transform-read) | A list of custom transforms associated with this source. A transform will be considered associated with a source if any attributes of the transform specify the source as the sourceName. | [optional]
|
||||
**DependentApps** | [**[]DependantAppConnections**](dependant-app-connections) | | [optional]
|
||||
**MissingDependents** | [**[]DependantConnectionsMissingDto**](dependant-connections-missing-dto) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$SourceConnectionsDto = Initialize-PSSailpoint.V2024SourceConnectionsDto -IdentityProfiles null `
|
||||
-CredentialProfiles null `
|
||||
-SourceAttributes null `
|
||||
-MappingProfiles [ODS-AD-Profile, ODS-Profile2] `
|
||||
-DependentCustomTransforms [{id=61190eae-290b-4335-aeb8-7335f1fd99cb, name=Split Transform, type=split, attributes={delimiter=-, index=1, input={attributes={sourceName=Example CSV Source, attributeName=last_name}, type=accountAttribute}}, internal=false}] `
|
||||
-DependentApps null `
|
||||
-MissingDependents null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$SourceConnectionsDto | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user