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

Update to powershell SDK docs: 13683713257

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-05 19:14:44 +00:00
parent de6cdc4308
commit 4df3ae99f3
6 changed files with 15 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tools/sdk/powershell/Reference/Beta/Models/ImportObject.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'ImportObject', 'BetaImportObject']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "RULE", "SOURCE", "TRANSFORM", "TRIGGER_SUBSCRIPTION" ] | DTO type of object created or updated by import. | [optional]
**Type** | **Enum** [ "CONNECTOR_RULE", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "RULE", "SOURCE", "TRANSFORM", "TRIGGER_SUBSCRIPTION" ] | DTO type of object created or updated by import. | [optional]
**Id** | **String** | ID of object created or updated by import. | [optional]
**Name** | **String** | Display name of object created or updated by import. | [optional]

2
docs/tools/sdk/powershell/Reference/Beta/Models/SelfImportExportDto.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SelfImportExportDto', 'BetaSelfImport
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Imported/exported object's DTO type. Import is currently only possible with the IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional]
**Type** | **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "CONNECTOR_RULE", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Imported/exported object's DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional]
**Id** | **String** | Imported/exported object's ID. | [optional]
**Name** | **String** | Imported/exported object's display name. | [optional]

22
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md
View File

@@ -271,18 +271,16 @@ try {
[[Back to top]](#)
## import-sp-config
"This post will import objects from a JSON configuration file into\
\ a tenant. By default, every import will first export all existing objects supported\
\ by sp-config as a backup before the import is attempted. The backup is provided\
\ so that the state of the configuration prior to the import is available for\
\ inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\"\
\ to true in the import options. If a backup is performed, the id of the backup\
\ will be provided in the ImportResult as the \"exportJobId\". This can be downloaded\
\ using the `/sp-config/export/{exportJobId}/download` endpoint.\nYou cannot currently\
\ import from the Non-Employee Lifecycle Management (NELM) source. You cannot\
\ use this endpoint to back up or store NELM data. \nFor more information about\
\ the object types that currently support import functionality, refer to [SaaS\
\ Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects)."
This post will import objects from a JSON configuration file into a tenant.
By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted.
The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed.
The backup can be skipped by setting "excludeBackup" to true in the import options.
If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded
using the `/sp-config/export/{exportJobId}/download` endpoint.
You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data.
For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-sp-config)

2
docs/tools/sdk/powershell/Reference/V2024/Models/ImportObject.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'ImportObject', 'V2024ImportObject']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "RULE", "SOURCE", "TRANSFORM", "TRIGGER_SUBSCRIPTION" ] | DTO type of object created or updated by import. | [optional]
**Type** | **Enum** [ "CONNECTOR_RULE", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "RULE", "SOURCE", "TRANSFORM", "TRIGGER_SUBSCRIPTION" ] | DTO type of object created or updated by import. | [optional]
**Id** | **String** | ID of object created or updated by import. | [optional]
**Name** | **String** | Display name of object created or updated by import. | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/SelfImportExportDto.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SelfImportExportDto', 'V2024SelfImpor
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Imported/exported object's DTO type. Import is currently only possible with the IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional]
**Type** | **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "CONNECTOR_RULE", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Imported/exported object's DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional]
**Id** | **String** | Imported/exported object's ID. | [optional]
**Name** | **String** | Imported/exported object's display name. | [optional]

2
docs/tools/sdk/powershell/Reference/V3/Models/ImportObject.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'ImportObject', 'ImportObject']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "RULE", "SOURCE", "TRANSFORM", "TRIGGER_SUBSCRIPTION" ] | DTO type of object created or updated by import. | [optional]
**Type** | **Enum** [ "CONNECTOR_RULE", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "RULE", "SOURCE", "TRANSFORM", "TRIGGER_SUBSCRIPTION" ] | DTO type of object created or updated by import. | [optional]
**Id** | **String** | ID of object created or updated by import. | [optional]
**Name** | **String** | Display name of object created or updated by import. | [optional]