From 09ed592191d39d8840748eaf9fb05fa5dfee75d8 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Fri, 7 Feb 2025 20:53:08 +0000 Subject: [PATCH] Update to powershell SDK docs: 13207859154 --- .../Methods/BetaAccessModelMetadataApi.md | 28 +- .../Beta/Methods/BetaAccessProfilesApi.md | 56 +- .../Methods/BetaAccessRequestApprovalsApi.md | 42 +- .../BetaAccessRequestIdentityMetricsApi.md | 7 +- .../Beta/Methods/BetaAccessRequestsApi.md | 40 +- .../Beta/Methods/BetaAccountActivitiesApi.md | 14 +- .../Methods/BetaAccountAggregationsApi.md | 7 +- .../Beta/Methods/BetaAccountUsagesApi.md | 7 +- .../Reference/Beta/Methods/BetaAccountsApi.md | 112 +- .../Methods/BetaApplicationDiscoveryApi.md | 33 +- .../Beta/Methods/BetaApprovalsApi.md | 14 +- .../Reference/Beta/Methods/BetaAppsApi.md | 98 +- .../Beta/Methods/BetaAuthProfileApi.md | 19 +- .../Methods/BetaCertificationCampaignsApi.md | 218 +- .../Beta/Methods/BetaCertificationsApi.md | 44 +- .../Methods/BetaConnectorRuleManagementApi.md | 40 +- .../Beta/Methods/BetaConnectorsApi.md | 7 +- .../Beta/Methods/BetaCustomFormsApi.md | 129 +- .../BetaCustomPasswordInstructionsApi.md | 21 +- .../Beta/Methods/BetaEntitlementsApi.md | 87 +- .../Beta/Methods/BetaGovernanceGroupsApi.md | 70 +- .../BetaIAIAccessRequestRecommendationsApi.md | 56 +- .../Beta/Methods/BetaIAICommonAccessApi.md | 21 +- .../Beta/Methods/BetaIAIMessageCatalogsApi.md | 7 +- .../Beta/Methods/BetaIAIOutliersApi.md | 63 +- .../Methods/BetaIAIPeerGroupStrategiesApi.md | 10 +- .../Beta/Methods/BetaIAIRecommendationsApi.md | 19 +- .../Beta/Methods/BetaIAIRoleMiningApi.md | 175 +- .../Reference/Beta/Methods/BetaIconsApi.md | 14 +- .../Beta/Methods/BetaIdentitiesApi.md | 77 +- .../Beta/Methods/BetaIdentityAttributesApi.md | 42 +- .../Beta/Methods/BetaIdentityHistoryApi.md | 77 +- .../Beta/Methods/BetaIdentityProfilesApi.md | 77 +- .../Beta/Methods/BetaLaunchersApi.md | 42 +- .../Beta/Methods/BetaLifecycleStatesApi.md | 14 +- .../Beta/Methods/BetaMFAConfigurationApi.md | 52 +- .../Beta/Methods/BetaMFAControllerApi.md | 42 +- .../Beta/Methods/BetaManagedClientsApi.md | 20 +- .../Beta/Methods/BetaManagedClustersApi.md | 40 +- .../Methods/BetaMultiHostIntegrationApi.md | 89 +- .../BetaNonEmployeeLifecycleManagementApi.md | 224 +- .../Beta/Methods/BetaNotificationsApi.md | 101 +- .../Beta/Methods/BetaOAuthClientsApi.md | 35 +- .../Beta/Methods/BetaOrgConfigApi.md | 17 +- .../Methods/BetaPasswordConfigurationApi.md | 19 +- .../Beta/Methods/BetaPasswordDictionaryApi.md | 12 +- .../Beta/Methods/BetaPasswordManagementApi.md | 28 +- .../Beta/Methods/BetaPasswordPoliciesApi.md | 35 +- .../Beta/Methods/BetaPasswordSyncGroupsApi.md | 35 +- .../Methods/BetaPersonalAccessTokensApi.md | 28 +- .../Methods/BetaPublicIdentitiesConfigApi.md | 12 +- .../Beta/Methods/BetaRequestableObjectsApi.md | 7 +- .../Beta/Methods/BetaRoleInsightsApi.md | 65 +- .../Reference/Beta/Methods/BetaRolesApi.md | 56 +- .../Beta/Methods/BetaSIMIntegrationsApi.md | 47 +- .../Beta/Methods/BetaSODPoliciesApi.md | 158 +- .../Beta/Methods/BetaSODViolationsApi.md | 10 +- .../Reference/Beta/Methods/BetaSPConfigApi.md | 47 +- .../BetaSearchAttributeConfigurationApi.md | 33 +- .../Reference/Beta/Methods/BetaSegmentsApi.md | 35 +- .../Methods/BetaServiceDeskIntegrationApi.md | 66 +- .../Beta/Methods/BetaSourceUsagesApi.md | 14 +- .../Reference/Beta/Methods/BetaSourcesApi.md | 301 +- .../BetaSuggestedEntitlementDescriptionApi.md | 47 +- .../Beta/Methods/BetaTaggedObjectsApi.md | 56 +- .../Reference/Beta/Methods/BetaTagsApi.md | 28 +- .../Beta/Methods/BetaTaskManagementApi.md | 35 +- .../Reference/Beta/Methods/BetaTenantApi.md | 5 +- .../Beta/Methods/BetaTransformsApi.md | 35 +- .../Reference/Beta/Methods/BetaTriggersApi.md | 70 +- .../Beta/Methods/BetaUIMetadataApi.md | 12 +- .../Methods/BetaVendorConnectorMappingsApi.md | 19 +- .../Beta/Methods/BetaWorkItemsApi.md | 91 +- .../Beta/Methods/BetaWorkReassignmentApi.md | 57 +- .../Beta/Methods/BetaWorkflowsApi.md | 122 +- .../Reference/Beta/Methods/index.md | 1 - .../Reference/Beta/Models/AccountUsage.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../powershell/Reference/Beta/Models/index.md | 5 +- .../Methods/V2024AccessModelMetadataApi.md | 40 +- .../V2024/Methods/V2024AccessProfilesApi.md | 59 +- .../Methods/V2024AccessRequestApprovalsApi.md | 53 +- .../V2024AccessRequestIdentityMetricsApi.md | 10 +- .../V2024/Methods/V2024AccessRequestsApi.md | 64 +- .../Methods/V2024AccountActivitiesApi.md | 14 +- .../Methods/V2024AccountAggregationsApi.md | 10 +- .../V2024/Methods/V2024AccountUsagesApi.md | 7 +- .../V2024/Methods/V2024AccountsApi.md | 127 +- .../Methods/V2024ApplicationDiscoveryApi.md | 19 +- .../V2024/Methods/V2024ApprovalsApi.md | 20 +- .../Reference/V2024/Methods/V2024AppsApi.md | 140 +- .../V2024/Methods/V2024AuthProfileApi.md | 30 +- .../V2024/Methods/V2024AuthUsersApi.md | 14 +- .../V2024/Methods/V2024BrandingApi.md | 33 +- .../V2024CertificationCampaignFiltersApi.md | 35 +- .../Methods/V2024CertificationCampaignsApi.md | 152 +- .../Methods/V2024CertificationSummariesApi.md | 28 +- .../V2024/Methods/V2024CertificationsApi.md | 77 +- .../V2024/Methods/V2024ConfigurationHubApi.md | 110 +- .../V2024ConnectorRuleManagementApi.md | 60 +- .../V2024/Methods/V2024ConnectorsApi.md | 91 +- .../V2024/Methods/V2024CustomFormsApi.md | 194 +- .../V2024CustomPasswordInstructionsApi.md | 30 +- .../V2024/Methods/V2024DataSegmentationApi.md | 77 +- .../V2024/Methods/V2024DimensionsApi.md | 56 +- .../V2024/Methods/V2024EntitlementsApi.md | 123 +- .../V2024GlobalTenantSecuritySettingsApi.md | 19 +- .../V2024/Methods/V2024GovernanceGroupsApi.md | 100 +- ...V2024IAIAccessRequestRecommendationsApi.md | 80 +- .../V2024/Methods/V2024IAICommonAccessApi.md | 30 +- .../V2024/Methods/V2024IAIOutliersApi.md | 90 +- .../Methods/V2024IAIPeerGroupStrategiesApi.md | 13 +- .../Methods/V2024IAIRecommendationsApi.md | 30 +- .../V2024/Methods/V2024IAIRoleMiningApi.md | 250 +- .../Reference/V2024/Methods/V2024IconsApi.md | 20 +- .../V2024/Methods/V2024IdentitiesApi.md | 112 +- .../Methods/V2024IdentityAttributesApi.md | 60 +- .../V2024/Methods/V2024IdentityHistoryApi.md | 110 +- .../V2024/Methods/V2024IdentityProfilesApi.md | 77 +- .../V2024/Methods/V2024LifecycleStatesApi.md | 42 +- .../V2024/Methods/V2024MFAConfigurationApi.md | 45 +- .../V2024/Methods/V2024ManagedClientsApi.md | 42 +- .../V2024/Methods/V2024ManagedClustersApi.md | 49 +- .../V2024NonEmployeeLifecycleManagementApi.md | 224 +- .../V2024/Methods/V2024NotificationsApi.md | 150 +- .../V2024/Methods/V2024OAuthClientsApi.md | 35 +- .../V2024/Methods/V2024OrgConfigApi.md | 30 +- .../Methods/V2024PasswordConfigurationApi.md | 19 +- .../Methods/V2024PasswordDictionaryApi.md | 12 +- .../Methods/V2024PasswordManagementApi.md | 31 +- .../V2024/Methods/V2024PasswordPoliciesApi.md | 35 +- .../Methods/V2024PasswordSyncGroupsApi.md | 35 +- .../Methods/V2024PersonalAccessTokensApi.md | 28 +- .../V2024/Methods/V2024PublicIdentitiesApi.md | 7 +- .../Methods/V2024PublicIdentitiesConfigApi.md | 12 +- .../Methods/V2024ReportsDataExtractionApi.md | 28 +- .../Methods/V2024RequestableObjectsApi.md | 7 +- .../V2024/Methods/V2024RoleInsightsApi.md | 96 +- .../Reference/V2024/Methods/V2024RolesApi.md | 113 +- .../V2024/Methods/V2024SIMIntegrationsApi.md | 70 +- .../V2024/Methods/V2024SODPoliciesApi.md | 117 +- .../V2024/Methods/V2024SODViolationsApi.md | 14 +- .../V2024/Methods/V2024SPConfigApi.md | 70 +- .../V2024/Methods/V2024SavedSearchApi.md | 42 +- .../V2024/Methods/V2024ScheduledSearchApi.md | 42 +- .../Reference/V2024/Methods/V2024SearchApi.md | 36 +- .../V2024SearchAttributeConfigurationApi.md | 33 +- .../V2024/Methods/V2024SegmentsApi.md | 35 +- .../Methods/V2024ServiceDeskIntegrationApi.md | 66 +- .../V2024/Methods/V2024SourceUsagesApi.md | 14 +- .../V2024/Methods/V2024SourcesApi.md | 391 +- ...V2024SuggestedEntitlementDescriptionApi.md | 70 +- .../V2024/Methods/V2024TaggedObjectsApi.md | 56 +- .../V2024/Methods/V2024TaskManagementApi.md | 50 +- .../Reference/V2024/Methods/V2024TenantApi.md | 10 +- .../V2024/Methods/V2024TransformsApi.md | 35 +- .../V2024/Methods/V2024TriggersApi.md | 100 +- .../V2024/Methods/V2024UIMetadataApi.md | 20 +- .../V2024VendorConnectorMappingsApi.md | 19 +- .../V2024/Methods/V2024WorkItemsApi.md | 91 +- .../V2024/Methods/V2024WorkReassignmentApi.md | 90 +- .../V2024/Methods/V2024WorkflowsApi.md | 122 +- .../Reference/V2024/Methods/index.md | 1 - .../Reference/V2024/Models/AccountUsage.md | 2 +- .../V2024/Models/AggregationResult.md | 2 +- .../V2024/Models/CreateSavedSearchRequest.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V2024/Models/PendingApproval.md | 2 + .../V2024/Models/ReportDetailsArguments.md | 2 +- .../Reference/V2024/Models/SavedSearch.md | 2 +- .../V2024/Models/SavedSearchDetail.md | 2 +- .../Reference/V2024/Models/Search.md | 2 +- .../Reference/V2024/Models/SearchDocument.md | 169 + .../Models/SearchExportReportArguments.md | 2 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../Reference/V2024/Models/index.md | 5 +- .../Reference/V3/Methods/AccessProfilesApi.md | 35 +- .../V3/Methods/AccessRequestApprovalsApi.md | 38 +- .../Reference/V3/Methods/AccessRequestsApi.md | 31 +- .../V3/Methods/AccountActivitiesApi.md | 8 +- .../Reference/V3/Methods/AccountUsagesApi.md | 3 + .../Reference/V3/Methods/AccountsApi.md | 59 +- .../V3/Methods/ApplicationDiscoveryApi.md | 13 +- .../Reference/V3/Methods/AuthUsersApi.md | 10 +- .../Reference/V3/Methods/BrandingApi.md | 21 +- .../CertificationCampaignFiltersApi.md | 29 +- .../V3/Methods/CertificationCampaignsApi.md | 108 +- .../V3/Methods/CertificationSummariesApi.md | 16 +- .../Reference/V3/Methods/CertificationsApi.md | 51 +- .../V3/Methods/ConfigurationHubApi.md | 45 +- .../Reference/V3/Methods/ConnectorsApi.md | 51 +- .../GlobalTenantSecuritySettingsApi.md | 55 +- .../V3/Methods/IdentityProfilesApi.md | 57 +- .../V3/Methods/LifecycleStatesApi.md | 34 +- .../V3/Methods/MFAConfigurationApi.md | 42 +- .../Reference/V3/Methods/MFAControllerApi.md | 42 +- .../Reference/V3/Methods/ManagedClientsApi.md | 30 +- .../V3/Methods/ManagedClustersApi.md | 35 +- .../NonEmployeeLifecycleManagementApi.md | 150 +- .../Reference/V3/Methods/OAuthClientsApi.md | 25 +- .../V3/Methods/PasswordConfigurationApi.md | 19 +- .../V3/Methods/PasswordDictionaryApi.md | 10 +- .../V3/Methods/PasswordManagementApi.md | 17 +- .../V3/Methods/PasswordPoliciesApi.md | 25 +- .../V3/Methods/PasswordSyncGroupsApi.md | 25 +- .../V3/Methods/PersonalAccessTokensApi.md | 22 +- .../V3/Methods/PublicIdentitiesApi.md | 5 +- .../V3/Methods/PublicIdentitiesConfigApi.md | 12 +- .../V3/Methods/ReportsDataExtractionApi.md | 18 +- .../V3/Methods/RequestableObjectsApi.md | 5 +- .../Reference/V3/Methods/RolesApi.md | 35 +- .../Reference/V3/Methods/SODPoliciesApi.md | 77 +- .../Reference/V3/Methods/SODViolationsApi.md | 14 +- .../Reference/V3/Methods/SavedSearchApi.md | 32 +- .../V3/Methods/ScheduledSearchApi.md | 32 +- .../Reference/V3/Methods/SearchApi.md | 34 +- .../SearchAttributeConfigurationApi.md | 25 +- .../Reference/V3/Methods/SegmentsApi.md | 25 +- .../V3/Methods/ServiceDeskIntegrationApi.md | 52 +- .../Reference/V3/Methods/SourceUsagesApi.md | 6 + .../Reference/V3/Methods/SourcesApi.md | 128 +- .../Reference/V3/Methods/TaggedObjectsApi.md | 46 +- .../Reference/V3/Methods/TransformsApi.md | 23 +- .../V3/Methods/VendorConnectorMappingsApi.md | 19 +- .../Reference/V3/Methods/WorkItemsApi.md | 61 +- .../Reference/V3/Methods/WorkflowsApi.md | 84 +- .../powershell/Reference/V3/Methods/index.md | 1 - .../Reference/V3/Models/AccountUsage.md | 2 +- .../Reference/V3/Models/AggregationResult.md | 2 +- .../V3/Models/CreateSavedSearchRequest.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 4 +- .../Reference/V3/Models/PendingApproval.md | 2 + .../V3/Models/ReportDetailsArguments.md | 2 +- .../Reference/V3/Models/SavedSearch.md | 2 +- .../Reference/V3/Models/SavedSearchDetail.md | 2 +- .../powershell/Reference/V3/Models/Search.md | 2 +- .../Reference/V3/Models/SearchDocument.md | 169 + .../V3/Models/SearchExportReportArguments.md | 2 +- .../Reference/V3/Models/SourceUsage.md | 2 +- .../powershell/Reference/V3/Models/index.md | 5 +- .../beta/code_examples_overlay.yaml | 2556 ++++++------- .../v2024/code_examples_overlay.yaml | 3266 ++++++++--------- .../v3/code_examples_overlay.yaml | 2476 ++++++------- 244 files changed, 12907 insertions(+), 6931 deletions(-) create mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/SearchDocument.md create mode 100644 docs/tools/sdk/powershell/Reference/V3/Models/SearchDocument.md diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md index 1d6bbf1b5..0ead26ada 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md @@ -32,9 +32,12 @@ Method | HTTP request | Description [**Get-BetaAccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes [**Get-BetaAccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values + ## get-access-model-metadata-attribute Get single Access Model Metadata Attribute +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-model-metadata-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -64,19 +67,22 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute. # Get Access Model Metadata Attribute try { - Get-BetaAccessModelMetadataAttribute -BetaKey $Key + Get-BetaAccessModelMetadataAttribute -Key $Key # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttribute -BetaKey $Key + # Get-BetaAccessModelMetadataAttribute -Key $Key } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-model-metadata-attribute-value Get single Access Model Metadata Attribute Value +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-model-metadata-attribute-value) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -108,19 +114,22 @@ $Value = "public" # String | Technical name of the Attribute value. # Get Access Model Metadata Value try { - Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key -BetaValue $Value + Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key -BetaValue $Value + # Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-access-model-metadata-attribute Get a list of Access Model Metadata Attributes +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-model-metadata-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -150,19 +159,22 @@ $Filters = 'name eq "Privacy"' # String | Filter results using the standard synt # List Access Model Metadata Attributes try { - Get-BetaAccessModelMetadataAttribute + Get-BetaAccessModelMetadataAttribute # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttribute -BetaFilters $Filters + # Get-BetaAccessModelMetadataAttribute -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-access-model-metadata-attribute-value Get a list of Access Model Metadata Attribute Values +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-model-metadata-attribute-value) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -192,10 +204,10 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute. # List Access Model Metadata Values try { - Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key + Get-BetaAccessModelMetadataAttributeValue -Key $Key # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key + # Get-BetaAccessModelMetadataAttributeValue -Key $Key } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md index d13cfd983..b8d1d720e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md @@ -60,11 +60,14 @@ Method | HTTP request | Description [**Update-BetaAccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile [**Update-BetaAccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. + ## create-access-profile Use this API to create an access profile. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -179,16 +182,17 @@ $AccessProfile = @"{ try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-BetaAccessProfile -BetaAccessProfile $Result + New-BetaAccessProfile -BetaAccessProfile $Result # Below is a request that includes all optional parameters - # New-BetaAccessProfile -BetaAccessProfile $AccessProfile + # New-BetaAccessProfile -BetaAccessProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-access-profile This API deletes an existing Access Profile. @@ -196,6 +200,8 @@ The Access Profile must not be in use, for example, Access Profile can not be de A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -225,22 +231,25 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to # Delete the specified Access Profile try { - Remove-BetaAccessProfile -BetaId $Id + Remove-BetaAccessProfile -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaAccessProfile -BetaId $Id + # Remove-BetaAccessProfile -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-access-profiles-in-bulk This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profiles-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -275,19 +284,22 @@ $AccessProfileBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $Result + Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest + # Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-profile This API returns an Access Profile by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -317,20 +329,23 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile # Get an Access Profile try { - Get-BetaAccessProfile -BetaId $Id + Get-BetaAccessProfile -Id $Id # Below is a request that includes all optional parameters - # Get-BetaAccessProfile -BetaId $Id + # Get-BetaAccessProfile -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-profile-entitlements Use this API to get a list of an access profile's entitlements. A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-profile-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -370,20 +385,23 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List Access Profile's Entitlements try { - Get-BetaAccessProfileEntitlements -BetaId $Id + Get-BetaAccessProfileEntitlements -Id $Id # Below is a request that includes all optional parameters - # Get-BetaAccessProfileEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaAccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfileEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-access-profiles Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -427,16 +445,17 @@ $IncludeUnsegmented = $false # Boolean | Indicates whether the response list sho # List Access Profiles try { - Get-BetaAccessProfiles + Get-BetaAccessProfiles # Below is a request that includes all optional parameters - # Get-BetaAccessProfiles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented + # Get-BetaAccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-access-profile This API updates an existing Access Profile. The following fields are patchable: **name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** @@ -445,6 +464,8 @@ A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is requi > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -482,16 +503,17 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaAccessProfile -BetaId $Id -BetaJsonPatchOperation $Result + Update-BetaAccessProfile -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaAccessProfile -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaAccessProfile -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-access-profiles-in-bulk This API initiates a bulk update of field requestable for one or more Access Profiles. @@ -501,6 +523,8 @@ This API initiates a bulk update of field requestable for one or more Access Pro > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN user may only use this API to update Access Profiles which are associated with Sources they are able to administer. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-access-profiles-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -533,10 +557,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner - Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $Result + Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $AccessProfileBulkUpdateRequestInner + # Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfilesInBulk" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md index 348ce188f..432d6412b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md @@ -41,9 +41,12 @@ Method | HTTP request | Description [**Get-BetaPendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List [**Deny-BetaAccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + ## approve-access-request Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -85,19 +88,22 @@ $CommentDto = @"{ try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Approve-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $Result + Approve-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result # Below is a request that includes all optional parameters - # Approve-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto + # Approve-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## forward-access-request Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. +[API Spec](https://developer.sailpoint.com/docs/api/beta/forward-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -134,19 +140,22 @@ $ForwardApprovalDto = @"{ try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-BetaForwardAccessRequest -BetaApprovalId $ApprovalId -BetaForwardApprovalDto $Result + Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -BetaForwardApprovalDto $Result # Below is a request that includes all optional parameters - # Invoke-BetaForwardAccessRequest -BetaApprovalId $ApprovalId -BetaForwardApprovalDto $ForwardApprovalDto + # Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -BetaForwardApprovalDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-approval-summary Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-approval-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -178,19 +187,22 @@ $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and tim # Get Access Requests Approvals Number try { - Get-BetaAccessRequestApprovalSummary + Get-BetaAccessRequestApprovalSummary # Below is a request that includes all optional parameters - # Get-BetaAccessRequestApprovalSummary -BetaOwnerId $OwnerId -BetaFromDate $FromDate + # Get-BetaAccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestApprovalSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-completed-approvals This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-completed-approvals) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -229,19 +241,22 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ # Completed Access Request Approvals List try { - Get-BetaCompletedApprovals + Get-BetaCompletedApprovals # Below is a request that includes all optional parameters - # Get-BetaCompletedApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaCompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedApprovals" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-pending-approvals This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-pending-approvals) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -280,19 +295,22 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ # Pending Access Request Approvals List try { - Get-BetaPendingApprovals + Get-BetaPendingApprovals # Below is a request that includes all optional parameters - # Get-BetaPendingApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaPendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingApprovals" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reject-access-request Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. +[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -334,10 +352,10 @@ $CommentDto = @"{ try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $Result + Deny-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result # Below is a request that includes all optional parameters - # Deny-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto + # Deny-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaAccessRequest" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestIdentityMetricsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestIdentityMetricsApi.md index ce31b3404..dd7b8227b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestIdentityMetricsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestIdentityMetricsApi.md @@ -23,9 +23,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-BetaAccessRequestIdentityMetrics**](#get-access-request-identity-metrics) | **GET** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics + ## get-access-request-identity-metrics Use this API to return information access metrics. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-identity-metrics) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -59,10 +62,10 @@ $Type = "ENTITLEMENT" # String | Requested access item's type. # Return access request identity metrics try { - Get-BetaAccessRequestIdentityMetrics -BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type + Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type # Below is a request that includes all optional parameters - # Get-BetaAccessRequestIdentityMetrics -BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type + # Get-BetaAccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md index 4b1eb2235..34e352dca 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md @@ -39,10 +39,13 @@ Method | HTTP request | Description [**Get-BetaAccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status [**Set-BetaAccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration + ## cancel-access-request This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. +[API Spec](https://developer.sailpoint.com/docs/api/beta/cancel-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -77,16 +80,17 @@ $CancelAccessRequest = @"{ try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-BetaAccessRequest -BetaCancelAccessRequest $Result + Suspend-BetaAccessRequest -BetaCancelAccessRequest $Result # Below is a request that includes all optional parameters - # Suspend-BetaAccessRequest -BetaCancelAccessRequest $CancelAccessRequest + # Suspend-BetaAccessRequest -BetaCancelAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## close-access-request This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). @@ -101,6 +105,8 @@ To track the status of endpoint requests, navigate to Search and use this query: This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed. +[API Spec](https://developer.sailpoint.com/docs/api/beta/close-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -136,16 +142,17 @@ $CloseAccessRequest = @"{ try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest - Close-BetaAccessRequest -BetaCloseAccessRequest $Result + Close-BetaAccessRequest -BetaCloseAccessRequest $Result # Below is a request that includes all optional parameters - # Close-BetaAccessRequest -BetaCloseAccessRequest $CloseAccessRequest + # Close-BetaAccessRequest -BetaCloseAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-access-request Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. @@ -179,6 +186,8 @@ __REVOKE_ACCESS__ * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -262,19 +271,22 @@ $AccessRequest = @"{ try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-BetaAccessRequest -BetaAccessRequest $Result + New-BetaAccessRequest -BetaAccessRequest $Result # Below is a request that includes all optional parameters - # New-BetaAccessRequest -BetaAccessRequest $AccessRequest + # New-BetaAccessRequest -BetaAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-config This endpoint returns the current access-request configuration. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -302,7 +314,7 @@ Code | Description | Data Type # Get Access Request Configuration try { - Get-BetaAccessRequestConfig + Get-BetaAccessRequestConfig # Below is a request that includes all optional parameters # Get-BetaAccessRequestConfig @@ -312,11 +324,14 @@ try { } ``` [[Back to top]](#) + ## list-access-request-status Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-request-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -364,19 +379,22 @@ $RequestState = "request-state=EXECUTING" # String | Filter the results by the s # Access Request Status try { - Get-BetaAccessRequestStatus + Get-BetaAccessRequestStatus # Below is a request that includes all optional parameters - # Get-BetaAccessRequestStatus -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaAssignedTo $AssignedTo -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters -BetaSorters $Sorters -BetaRequestState $RequestState + # Get-BetaAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-access-request-config This endpoint replaces the current access-request configuration. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-access-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -432,10 +450,10 @@ $AccessRequestConfig = @"{ try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-BetaAccessRequestConfig -BetaAccessRequestConfig $Result + Set-BetaAccessRequestConfig -BetaAccessRequestConfig $Result # Below is a request that includes all optional parameters - # Set-BetaAccessRequestConfig -BetaAccessRequestConfig $AccessRequestConfig + # Set-BetaAccessRequestConfig -BetaAccessRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaAccessRequestConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountActivitiesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountActivitiesApi.md index 90a76d196..7ea0a7585 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountActivitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountActivitiesApi.md @@ -53,9 +53,12 @@ Method | HTTP request | Description [**Get-BetaAccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get Account Activity [**Get-BetaAccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities + ## get-account-activity This gets a single account activity by its id. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-activity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -86,19 +89,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id # Get Account Activity try { - Get-BetaAccountActivity -BetaId $Id + Get-BetaAccountActivity -Id $Id # Below is a request that includes all optional parameters - # Get-BetaAccountActivity -BetaId $Id + # Get-BetaAccountActivity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-account-activities This gets a collection of account activities that satisfy the given query parameters. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-account-activities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -144,10 +150,10 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ # List Account Activities try { - Get-BetaAccountActivities + Get-BetaAccountActivities # Below is a request that includes all optional parameters - # Get-BetaAccountActivities -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaAccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivities" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountAggregationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountAggregationsApi.md index bba567726..4836be8a3 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountAggregationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountAggregationsApi.md @@ -29,6 +29,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-BetaAccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status + ## get-account-aggregation-status This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. @@ -40,6 +41,8 @@ Since this endpoint reports on the status of an *in-progress* account aggregatio A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-aggregation-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -69,10 +72,10 @@ $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id # In-progress Account Aggregation status try { - Get-BetaAccountAggregationStatus -BetaId $Id + Get-BetaAccountAggregationStatus -Id $Id # Below is a request that includes all optional parameters - # Get-BetaAccountAggregationStatus -BetaId $Id + # Get-BetaAccountAggregationStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountUsagesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountUsagesApi.md index a1a7b6f9a..c0ed6995d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountUsagesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountUsagesApi.md @@ -22,9 +22,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-BetaUsagesByAccountId**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights + ## get-usages-by-account-id This API returns a summary of account usage insights for past 12 months. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-usages-by-account-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -62,10 +65,10 @@ $Sorters = "-date" # String | Sort results using the standard syntax described i # Returns account usage insights try { - Get-BetaUsagesByAccountId -BetaAccountId $AccountId + Get-BetaUsagesByAccountId -AccountId $AccountId # Below is a request that includes all optional parameters - # Get-BetaUsagesByAccountId -BetaAccountId $AccountId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters + # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md index 694812607..1f6fa05a4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md @@ -61,6 +61,7 @@ Method | HTTP request | Description [**Unlock-BetaAccount**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account [**Update-BetaAccount**](#update-account) | **PATCH** `/accounts/{id}` | Update Account + ## create-account Submits an account creation task - the API then returns the task ID. @@ -75,6 +76,8 @@ The endpoint doesn't actually provision the account on the target source, which By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -114,16 +117,17 @@ $AccountAttributesCreate = @"{ try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-BetaAccount -BetaAccountAttributesCreate $Result + New-BetaAccount -BetaAccountAttributesCreate $Result # Below is a request that includes all optional parameters - # New-BetaAccount -BetaAccountAttributesCreate $AccountAttributesCreate + # New-BetaAccount -BetaAccountAttributesCreate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-account Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. @@ -131,6 +135,8 @@ This endpoint only deletes the account from IdentityNow, not the source itself, A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**NOTE:** You can only delete accounts from sources of the "DelimitedFile" type.** +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -161,16 +167,17 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. # Delete Account try { - Remove-BetaAccount -BetaId $Id + Remove-BetaAccount -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaAccount -BetaId $Id + # Remove-BetaAccount -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccount" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-account-async Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. @@ -180,6 +187,8 @@ This endpoint is good for: * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-account-async) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -209,20 +218,23 @@ $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id # Remove Account try { - Remove-BetaAccountAsync -BetaId $Id + Remove-BetaAccountAsync -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaAccountAsync -BetaId $Id + # Remove-BetaAccountAsync -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountAsync" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## disable-account This API submits a task to disable the account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -259,19 +271,22 @@ $AccountToggleRequest = @"{ try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $Result + Disable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result # Below is a request that includes all optional parameters - # Disable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest + # Disable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## disable-account-for-identity This API submits a task to disable IDN account for a single identity. +[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-account-for-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -302,19 +317,22 @@ $Id = "2c91808384203c2d018437e631158309" # String | The identity id. # Disable IDN Account for Identity try { - Disable-BetaAccountForIdentity -BetaId $Id + Disable-BetaAccountForIdentity -Id $Id # Below is a request that includes all optional parameters - # Disable-BetaAccountForIdentity -BetaId $Id + # Disable-BetaAccountForIdentity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountForIdentity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## disable-accounts-for-identities This API submits tasks to disable IDN account for each identity provided in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/beta/disable-accounts-for-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -347,20 +365,23 @@ $IdentitiesAccountsBulkRequest = @"{ try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result + Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters - # Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + # Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## enable-account This API submits a task to enable account and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -397,19 +418,22 @@ $AccountToggleRequest = @"{ try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $Result + Enable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result # Below is a request that includes all optional parameters - # Enable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest + # Enable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## enable-account-for-identity This API submits a task to enable IDN account for a single identity. +[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-account-for-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -440,19 +464,22 @@ $Id = "2c91808384203c2d018437e631158309" # String | The identity id. # Enable IDN Account for Identity try { - Enable-BetaAccountForIdentity -BetaId $Id + Enable-BetaAccountForIdentity -Id $Id # Below is a request that includes all optional parameters - # Enable-BetaAccountForIdentity -BetaId $Id + # Enable-BetaAccountForIdentity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountForIdentity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## enable-accounts-for-identities This API submits tasks to enable IDN account for each identity provided in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/beta/enable-accounts-for-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -485,20 +512,23 @@ $IdentitiesAccountsBulkRequest = @"{ try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result + Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters - # Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + # Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-account Use this API to return the details for a single account by its ID. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -529,20 +559,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. # Account Details try { - Get-BetaAccount -BetaId $Id + Get-BetaAccount -Id $Id # Below is a request that includes all optional parameters - # Get-BetaAccount -BetaId $Id + # Get-BetaAccount -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccount" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-account-entitlements This API returns entitlements of the account. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-account-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -579,19 +612,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Account Entitlements try { - Get-BetaAccountEntitlements -BetaId $Id + Get-BetaAccountEntitlements -Id $Id # Below is a request that includes all optional parameters - # Get-BetaAccountEntitlements -BetaId $Id -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaAccountEntitlements -Id $Id -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-accounts List accounts. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-accounts) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -631,16 +667,17 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described # Accounts List try { - Get-BetaAccounts + Get-BetaAccounts # Below is a request that includes all optional parameters - # Get-BetaAccounts -BetaDetailLevel $DetailLevel -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaAccounts -DetailLevel $DetailLevel -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccounts" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-account Use this API to update an account with a PUT request. @@ -651,6 +688,8 @@ A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required t >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -692,20 +731,23 @@ $AccountAttributes = @"{ try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-BetaAccount -BetaId $Id -BetaAccountAttributes $Result + Send-BetaAccount -Id $Id -BetaAccountAttributes $Result # Below is a request that includes all optional parameters - # Send-BetaAccount -BetaId $Id -BetaAccountAttributes $AccountAttributes + # Send-BetaAccount -Id $Id -BetaAccountAttributes $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-reload-account This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-reload-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -736,21 +778,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id # Reload Account try { - Submit-BetaReloadAccount -BetaId $Id + Submit-BetaReloadAccount -Id $Id # Below is a request that includes all optional parameters - # Submit-BetaReloadAccount -BetaId $Id + # Submit-BetaReloadAccount -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReloadAccount" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## unlock-account This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/unlock-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -788,16 +833,17 @@ $AccountUnlockRequest = @"{ try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-BetaAccount -BetaId $Id -BetaAccountUnlockRequest $Result + Unlock-BetaAccount -Id $Id -BetaAccountUnlockRequest $Result # Below is a request that includes all optional parameters - # Unlock-BetaAccount -BetaId $Id -BetaAccountUnlockRequest $AccountUnlockRequest + # Unlock-BetaAccount -Id $Id -BetaAccountUnlockRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-BetaAccount" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-account Use this API to update account details. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. @@ -812,6 +858,8 @@ All accounts that are reassigned will be set to `manuallyCorrelated: true` unles >**Note:** The `attributes` field can only be modified for flat file accounts. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -847,10 +895,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaAccount -BetaId $Id -BetaRequestBody $Result + Update-BetaAccount -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Update-BetaAccount -BetaId $Id -BetaRequestBody $RequestBody + # Update-BetaAccount -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md index 4dce28fb4..b6371f436 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md @@ -25,10 +25,13 @@ Method | HTTP request | Description [**Update-BetaDiscoveredApplicationByID**](#patch-discovered-application-by-id) | **PATCH** `/discovered-applications/{id}` | Patch Discovered Application by ID [**Send-BetaManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **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](https://developer.sailpoint.com/docs/api/beta/get-discovered-application-by-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -58,20 +61,23 @@ $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's # Get Discovered Application by ID try { - Get-BetaDiscoveredApplicationByID -BetaId $Id + Get-BetaDiscoveredApplicationByID -Id $Id # Below is a request that includes all optional parameters - # Get-BetaDiscoveredApplicationByID -BetaId $Id + # 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](https://developer.sailpoint.com/docs/api/beta/get-discovered-applications) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -109,22 +115,25 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # Retrieve discovered applications for tenant try { - Get-BetaDiscoveredApplications + Get-BetaDiscoveredApplications # Below is a request that includes all optional parameters - # Get-BetaDiscoveredApplications -BetaLimit $Limit -BetaOffset $Offset -BetaDetail $Detail -BetaFilter $Filter -BetaSorters $Sorters + # 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](https://developer.sailpoint.com/docs/api/beta/get-manual-discover-applications-csv-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -152,7 +161,7 @@ Code | Description | Data Type # Download CSV Template for Discovery try { - Get-BetaManualDiscoverApplicationsCsvTemplate + Get-BetaManualDiscoverApplicationsCsvTemplate # Below is a request that includes all optional parameters # Get-BetaManualDiscoverApplicationsCsvTemplate @@ -162,10 +171,13 @@ try { } ``` [[Back to top]](#) + ## patch-discovered-application-by-id Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. You can patch these fields: - **associatedSources** - **dismissed** +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-discovered-application-by-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -202,20 +214,23 @@ $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's # Patch Discovered Application by ID try { - Update-BetaDiscoveredApplicationByID -BetaId $Id + Update-BetaDiscoveredApplicationByID -Id $Id # Below is a request that includes all optional parameters - # Update-BetaDiscoveredApplicationByID -BetaId $Id -BetaJsonPatchOperations $JsonPatchOperations + # Update-BetaDiscoveredApplicationByID -Id $Id -BetaJsonPatchOperations $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](https://developer.sailpoint.com/docs/api/beta/send-manual-discover-applications-csv-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -245,10 +260,10 @@ $File = # System.IO.FileInfo | The CSV file to upload containing `application_n # Upload CSV to Discover Applications try { - Send-BetaManualDiscoverApplicationsCsvTemplate -BetaFile $File + Send-BetaManualDiscoverApplicationsCsvTemplate -File $File # Below is a request that includes all optional parameters - # Send-BetaManualDiscoverApplicationsCsvTemplate -BetaFile $File + # Send-BetaManualDiscoverApplicationsCsvTemplate -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApprovalsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApprovalsApi.md index 0e3d5250b..73dd43d03 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApprovalsApi.md @@ -23,9 +23,12 @@ Method | HTTP request | Description [**Get-BetaApproval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get Approval [**Get-BetaApprovals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals + ## get-approval Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-approval) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -55,20 +58,23 @@ $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that # Get Approval try { - Get-BetaApproval -BetaId $Id + Get-BetaApproval -Id $Id # Below is a request that includes all optional parameters - # Get-BetaApproval -BetaId $Id + # Get-BetaApproval -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-approvals Get a list of approvals, which can be filtered by requester ID, status, or reference type. You can use the "Mine" query parameter to return all approvals for the current approver. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals. Absence of all query parameters will will default to mine=true. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-approvals) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -102,10 +108,10 @@ $Filters = 'filters=status eq PENDING' # String | Filter results using the stand # Get Approvals try { - Get-BetaApprovals + Get-BetaApprovals # Below is a request that includes all optional parameters - # Get-BetaApprovals -BetaMine $Mine -BetaRequesterId $RequesterId -BetaFilters $Filters + # Get-BetaApprovals -Mine $Mine -RequesterId $RequesterId -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md index c15ed62c2..bccd06fac 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md @@ -34,9 +34,12 @@ Method | HTTP request | Description [**Update-BetaUserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID [**Update-BetaSourceAppsInBulk**](#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 +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -76,19 +79,22 @@ $SourceAppCreateDto = @"{ try { $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto - New-BetaSourceApp -BetaSourceAppCreateDto $Result + New-BetaSourceApp -BetaSourceAppCreateDto $Result # Below is a request that includes all optional parameters - # New-BetaSourceApp -BetaSourceAppCreateDto $SourceAppCreateDto + # New-BetaSourceApp -BetaSourceAppCreateDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp" 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 +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-profiles-from-source-app-by-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -125,19 +131,22 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-BetaAccessProfilesFromSourceAppByBulk -BetaId $Id -BetaRequestBody $Result + Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Remove-BetaAccessProfilesFromSourceAppByBulk -BetaId $Id -BetaRequestBody $RequestBody -BetaLimit $Limit + # Remove-BetaAccessProfilesFromSourceAppByBulk -Id $Id -RequestBody $Result -Limit $Limit } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesFromSourceAppByBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-source-app Use this API to delete a specific source app +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -167,19 +176,22 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. # Delete source app by ID try { - Remove-BetaSourceApp -BetaId $Id + Remove-BetaSourceApp -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaSourceApp -BetaId $Id + # Remove-BetaSourceApp -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-app This API returns a source app by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -210,19 +222,22 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app # Get source app by ID try { - Get-BetaSourceApp -BetaId $Id + Get-BetaSourceApp -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSourceApp -BetaId $Id + # Get-BetaSourceApp -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp" 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 +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-profiles-for-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -258,21 +273,24 @@ $Filters = 'name eq "developer access profile"' # String | Filter results using # List access profiles for the specified source app try { - Get-BetaAccessProfilesForSourceApp -BetaId $Id + Get-BetaAccessProfilesForSourceApp -Id $Id # Below is a request that includes all optional parameters - # Get-BetaAccessProfilesForSourceApp -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + # Get-BetaAccessProfilesForSourceApp -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-all-source-app This API returns the list of all source apps for the org. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-all-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -310,20 +328,23 @@ $Filters = 'enabled eq true' # String | Filter results using the standard syntax # List all source apps try { - Get-BetaAllSourceApp + Get-BetaAllSourceApp # Below is a request that includes all optional parameters - # Get-BetaAllSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaAllSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp" 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. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-all-user-apps) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -359,19 +380,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # List all user apps try { - Get-BetaAllUserApps -BetaFilters $Filters + Get-BetaAllUserApps -Filters $Filters # Below is a request that includes all optional parameters - # Get-BetaAllUserApps -BetaFilters $Filters -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset + # Get-BetaAllUserApps -Filters $Filters -Limit $Limit -Count $Count -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-assigned-source-app This API returns the list of source apps assigned for logged in user. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-assigned-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -409,19 +433,22 @@ $Filters = 'name eq "source app name"' # String | Filter results using the stand # List assigned source apps try { - Get-BetaAssignedSourceApp + Get-BetaAssignedSourceApp # Below is a request that includes all optional parameters - # Get-BetaAssignedSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaAssignedSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp" 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. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-available-accounts-for-user-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -457,19 +484,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # List available accounts for user app try { - Get-BetaAvailableAccountsForUserApp -BetaId $Id + Get-BetaAvailableAccountsForUserApp -Id $Id # Below is a request that includes all optional parameters - # Get-BetaAvailableAccountsForUserApp -BetaId $Id -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset + # Get-BetaAvailableAccountsForUserApp -Id $Id -Limit $Limit -Count $Count -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-available-source-apps This API returns the list of source apps available for access request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-available-source-apps) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -507,19 +537,22 @@ $Filters = 'name eq "source app name"' # String | Filter results using the stand # List available source apps try { - Get-BetaAvailableSourceApps + Get-BetaAvailableSourceApps # Below is a request that includes all optional parameters - # Get-BetaAvailableSourceApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaAvailableSourceApps -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-owned-user-apps This API returns the list of user apps assigned to logged in user +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-owned-user-apps) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -555,21 +588,24 @@ $Filters = 'name eq "user app name"' # String | Filter results using the standar # List owned user apps try { - Get-BetaOwnedUserApps + Get-BetaOwnedUserApps # Below is a request that includes all optional parameters - # Get-BetaOwnedUserApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaFilters $Filters + # Get-BetaOwnedUserApps -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps" 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. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -607,20 +643,23 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patc # Patch source app by ID try { - Update-BetaSourceApp -BetaId $Id + Update-BetaSourceApp -Id $Id # Below is a request that includes all optional parameters - # Update-BetaSourceApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaSourceApp -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp" 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** +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-user-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -658,21 +697,24 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch # Patch user app by ID try { - Update-BetaUserApp -BetaId $Id + Update-BetaUserApp -Id $Id # Below is a request that includes all optional parameters - # Update-BetaUserApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaUserApp -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp" 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. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-source-apps-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -714,10 +756,10 @@ $SourceAppBulkUpdateRequest = @"{ # Bulk update source apps try { - Update-BetaSourceAppsInBulk + Update-BetaSourceAppsInBulk # Below is a request that includes all optional parameters - # Update-BetaSourceAppsInBulk -BetaSourceAppBulkUpdateRequest $SourceAppBulkUpdateRequest + # Update-BetaSourceAppsInBulk -BetaSourceAppBulkUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md index e74979130..a86868e12 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md @@ -27,9 +27,12 @@ Method | HTTP request | Description [**Get-BetaProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles. [**Update-BetaProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile + ## get-profile-config This API returns auth profile information. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-profile-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -60,19 +63,22 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to ge # Get Auth Profile. try { - Get-BetaProfileConfig -BetaId $Id + Get-BetaProfileConfig -Id $Id # Below is a request that includes all optional parameters - # Get-BetaProfileConfig -BetaId $Id + # Get-BetaProfileConfig -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-profile-config-list This API returns a list of auth profiles. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-profile-config-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -100,7 +106,7 @@ Code | Description | Data Type # Get list of Auth Profiles. try { - Get-BetaProfileConfigList + Get-BetaProfileConfigList # Below is a request that includes all optional parameters # Get-BetaProfileConfigList @@ -110,10 +116,13 @@ try { } ``` [[Back to top]](#) + ## patch-profile-config This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-profile-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -151,10 +160,10 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to pa try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaProfileConfig -BetaId $Id -BetaJsonPatchOperation $Result + Update-BetaProfileConfig -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaProfileConfig -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaProfileConfig -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md index 022e4b060..5e29675f3 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md @@ -105,7 +105,11 @@ Method | HTTP request | Description [**Start-BetaGenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template [**Update-BetaCampaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign + ## complete-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: :::caution This endpoint will run successfully for any campaigns that are **past due**. @@ -120,6 +124,8 @@ can complete a certification even if all items have not been completed. Though t A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -154,22 +160,28 @@ $CompleteCampaignOptions = @"{ # Complete a Campaign try { - Complete-BetaCampaign -BetaId $Id + Complete-BetaCampaign -Id $Id # Below is a request that includes all optional parameters - # Complete-BetaCampaign -BetaId $Id -BetaCompleteCampaignOptions $CompleteCampaignOptions + # Complete-BetaCampaign -Id $Id -BetaCompleteCampaignOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -308,22 +320,28 @@ $Campaign = @"{ try { $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-BetaCampaign -BetaCampaign $Result + New-BetaCampaign -BetaCampaign $Result # Below is a request that includes all optional parameters - # New-BetaCampaign -BetaCampaign $Campaign + # New-BetaCampaign -BetaCampaign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -477,22 +495,28 @@ $CampaignTemplate = @"{ try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-BetaCampaignTemplate -BetaCampaignTemplate $Result + New-BetaCampaignTemplate -BetaCampaignTemplate $Result # Below is a request that includes all optional parameters - # New-BetaCampaignTemplate -BetaCampaignTemplate $CampaignTemplate + # New-BetaCampaignTemplate -BetaCampaignTemplate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -523,22 +547,28 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template # Delete a Campaign Template try { - Remove-BetaCampaignTemplate -BetaId $Id + Remove-BetaCampaignTemplate -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaCampaignTemplate -BetaId $Id + # Remove-BetaCampaignTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-campaign-template-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaign-template-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -569,22 +599,28 @@ $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template # Delete Campaign Template Schedule try { - Remove-BetaCampaignTemplateSchedule -BetaId $Id + Remove-BetaCampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaCampaignTemplateSchedule -BetaId $Id + # Remove-BetaCampaignTemplateSchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplateSchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-campaigns +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-campaigns) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -618,22 +654,28 @@ $DeleteCampaignsRequest = @"{ try { $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest - Remove-BetaCampaigns -BetaDeleteCampaignsRequest $Result + Remove-BetaCampaigns -BetaDeleteCampaignsRequest $Result # Below is a request that includes all optional parameters - # Remove-BetaCampaigns -BetaDeleteCampaignsRequest $DeleteCampaignsRequest + # Remove-BetaCampaigns -BetaDeleteCampaignsRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-active-campaigns +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-active-campaigns) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -673,22 +715,28 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # List Campaigns try { - Get-BetaActiveCampaigns + Get-BetaActiveCampaigns # Below is a request that includes all optional parameters - # Get-BetaActiveCampaigns -BetaDetail $Detail -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaActiveCampaigns" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to get information for an existing certification campaign by the campaign's ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -719,22 +767,28 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be ret # Get Campaign try { - Get-BetaCampaign -BetaId $Id + Get-BetaCampaign -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCampaign -BetaId $Id + # Get-BetaCampaign -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaign" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign-reports +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-reports) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -765,22 +819,28 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose rep # Get Campaign Reports try { - Get-BetaCampaignReports -BetaId $Id + Get-BetaCampaignReports -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCampaignReports -BetaId $Id + # Get-BetaCampaignReports -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReports" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign-reports-config +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-reports-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -808,7 +868,7 @@ Code | Description | Data Type # Get Campaign Reports Configuration try { - Get-BetaCampaignReportsConfig + Get-BetaCampaignReportsConfig # Below is a request that includes all optional parameters # Get-BetaCampaignReportsConfig @@ -818,12 +878,18 @@ try { } ``` [[Back to top]](#) + ## get-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -854,22 +920,28 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template' # Get a Campaign Template try { - Get-BetaCampaignTemplate -BetaId $Id + Get-BetaCampaignTemplate -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCampaignTemplate -BetaId $Id + # Get-BetaCampaignTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign-template-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-template-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -900,17 +972,21 @@ $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template # Get Campaign Template Schedule try { - Get-BetaCampaignTemplateSchedule -BetaId $Id + Get-BetaCampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCampaignTemplateSchedule -BetaId $Id + # Get-BetaCampaignTemplateSchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplateSchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign-templates +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates). The endpoint returns all campaign templates matching the query parameters. @@ -918,6 +994,8 @@ The endpoint returns all campaign templates matching the query parameters. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-campaign-templates) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -955,22 +1033,28 @@ $Filters = 'name eq "manager template"' # String | Filter results using the stan # List Campaign Templates try { - Get-BetaCampaignTemplates + Get-BetaCampaignTemplates # Below is a request that includes all optional parameters - # Get-BetaCampaignTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaCampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplates" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## move +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/move) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1011,22 +1095,28 @@ $AdminReviewReassign = @"{ try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move-Beta -BetaId $Id -BetaAdminReviewReassign $Result + Move-Beta -Id $Id -BetaAdminReviewReassign $Result # Below is a request that includes all optional parameters - # Move-Beta -BetaId $Id -BetaAdminReviewReassign $AdminReviewReassign + # Move-Beta -Id $Id -BetaAdminReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1065,22 +1155,28 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaCampaignTemplate -BetaId $Id -BetaJsonPatchOperation $Result + Update-BetaCampaignTemplate -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaCampaignTemplate -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaCampaignTemplate -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-campaign-reports-config +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-campaign-reports-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1113,23 +1209,29 @@ $CampaignReportsConfig = @"{ try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $Result + Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $Result # Below is a request that includes all optional parameters - # Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $CampaignReportsConfig + # Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-campaign-template-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-campaign-template-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1181,22 +1283,28 @@ $Schedule = @"{ # Set Campaign Template Schedule try { - Set-BetaCampaignTemplateSchedule -BetaId $Id + Set-BetaCampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters - # Set-BetaCampaignTemplateSchedule -BetaId $Id -BetaSchedule $Schedule + # Set-BetaCampaignTemplateSchedule -Id $Id -BetaSchedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1231,22 +1339,28 @@ $ActivateCampaignOptions = @"{ # Activate a Campaign try { - Start-BetaCampaign -BetaId $Id + Start-BetaCampaign -Id $Id # Below is a request that includes all optional parameters - # Start-BetaCampaign -BetaId $Id -BetaActivateCampaignOptions $ActivateCampaignOptions + # Start-BetaCampaign -Id $Id -BetaActivateCampaignOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaign" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-campaign-remediation-scan +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign-remediation-scan) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1277,22 +1391,28 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remed # Run Campaign Remediation Scan try { - Start-BetaCampaignRemediationScan -BetaId $Id + Start-BetaCampaignRemediationScan -Id $Id # Below is a request that includes all optional parameters - # Start-BetaCampaignRemediationScan -BetaId $Id + # Start-BetaCampaignRemediationScan -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignRemediationScan" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-campaign-report +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report). A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-campaign-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1325,17 +1445,21 @@ $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run. # Run Campaign Report try { - Start-BetaCampaignReport -BetaId $Id -BetaType $Type + Start-BetaCampaignReport -Id $Id -Type $Type # Below is a request that includes all optional parameters - # Start-BetaCampaignReport -BetaId $Id -BetaType $Type + # Start-BetaCampaignReport -Id $Id -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignReport" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-generate-campaign-template +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description @@ -1353,6 +1477,8 @@ Though this Beta endpoint has been deprecated, you can find its V3 equivalent [h A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-generate-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1382,22 +1508,28 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template # Generate a Campaign from Template try { - Start-BetaGenerateCampaignTemplate -BetaId $Id + Start-BetaGenerateCampaignTemplate -Id $Id # Below is a request that includes all optional parameters - # Start-BetaGenerateCampaignTemplate -BetaId $Id + # Start-BetaGenerateCampaignTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaGenerateCampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-campaign +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1433,10 +1565,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of campaign update opera try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaCampaign -BetaId $Id -BetaRequestBody $Result + Update-BetaCampaign -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Update-BetaCampaign -BetaId $Id -BetaRequestBody $RequestBody + # Update-BetaCampaign -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaign" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md index 1471522c1..40dd6f023 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md @@ -38,9 +38,15 @@ Method | HTTP request | Description [**Get-BetaCertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification [**Submit-BetaReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + ## get-identity-certification-item-permissions +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-item-permissions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -81,19 +87,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Permissions for Entitlement Certification Item try { - Get-BetaIdentityCertificationItemPermissions -BetaCertificationId $CertificationId -BetaItemId $ItemId + Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId # Below is a request that includes all optional parameters - # Get-BetaIdentityCertificationItemPermissions -BetaCertificationId $CertificationId -BetaItemId $ItemId -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + # Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationItemPermissions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-certification-pending-tasks This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-pending-tasks) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -124,19 +133,22 @@ $Id = "MyId" # String | The identity campaign certification ID # Pending Certification Tasks try { - Get-BetaIdentityCertificationPendingTasks -BetaId $Id + Get-BetaIdentityCertificationPendingTasks -Id $Id # Below is a request that includes all optional parameters - # Get-BetaIdentityCertificationPendingTasks -BetaId $Id + # Get-BetaIdentityCertificationPendingTasks -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationPendingTasks" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-certification-task-status This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-certification-task-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -169,19 +181,25 @@ $TaskId = "MyTaskId" # String | The certification task ID # Certification Task Status try { - Get-BetaIdentityCertificationTaskStatus -BetaId $Id -BetaTaskId $TaskId + Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId # Below is a request that includes all optional parameters - # Get-BetaIdentityCertificationTaskStatus -BetaId $Id -BetaTaskId $TaskId + # Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationTaskStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-certification-reviewers +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-certification-reviewers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -222,19 +240,25 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # List of Reviewers for certification try { - Get-BetaCertificationReviewers -BetaId $Id + Get-BetaCertificationReviewers -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCertificationReviewers -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaCertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertificationReviewers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-reassign-certs-async +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-reassign-certs-async) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -278,10 +302,10 @@ $ReviewReassign = @"{ try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-BetaReassignCertsAsync -BetaId $Id -BetaReviewReassign $Result + Submit-BetaReassignCertsAsync -Id $Id -BetaReviewReassign $Result # Below is a request that includes all optional parameters - # Submit-BetaReassignCertsAsync -BetaId $Id -BetaReviewReassign $ReviewReassign + # Submit-BetaReassignCertsAsync -Id $Id -BetaReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReassignCertsAsync" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md index 6feb01791..87ddbe6d6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md @@ -30,10 +30,13 @@ Method | HTTP request | Description [**Update-BetaConnectorRule**](#update-connector-rule) | **PUT** `/connector-rules/{id}` | Update a Connector Rule [**Confirm-BetaConnectorRule**](#validate-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule + ## create-connector-rule Creates a new connector rule. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-connector-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -89,20 +92,23 @@ $ConnectorRuleCreateRequest = @"{ try { $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest - New-BetaConnectorRule -BetaConnectorRuleCreateRequest $Result + New-BetaConnectorRule -BetaConnectorRuleCreateRequest $Result # Below is a request that includes all optional parameters - # New-BetaConnectorRule -BetaConnectorRuleCreateRequest $ConnectorRuleCreateRequest + # New-BetaConnectorRule -BetaConnectorRuleCreateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-connector-rule Deletes the connector rule specified by the given ID. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-connector-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -133,20 +139,23 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to # Delete a Connector-Rule try { - Remove-BetaConnectorRule -BetaId $Id + Remove-BetaConnectorRule -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaConnectorRule -BetaId $Id + # Remove-BetaConnectorRule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-connector-rule Returns the connector rule specified by ID. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -177,20 +186,23 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to # Connector-Rule by ID try { - Get-BetaConnectorRule -BetaId $Id + Get-BetaConnectorRule -Id $Id # Below is a request that includes all optional parameters - # Get-BetaConnectorRule -BetaId $Id + # Get-BetaConnectorRule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-connector-rule-list Returns the list of connector rules. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-rule-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -218,7 +230,7 @@ Code | Description | Data Type # List Connector Rules try { - Get-BetaConnectorRuleList + Get-BetaConnectorRuleList # Below is a request that includes all optional parameters # Get-BetaConnectorRuleList @@ -228,10 +240,13 @@ try { } ``` [[Back to top]](#) + ## update-connector-rule Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-connector-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -290,20 +305,23 @@ $ConnectorRuleUpdateRequest = @"{ # Update a Connector Rule try { - Update-BetaConnectorRule -BetaId $Id + Update-BetaConnectorRule -Id $Id # Below is a request that includes all optional parameters - # Update-BetaConnectorRule -BetaId $Id -BetaConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest + # Update-BetaConnectorRule -Id $Id -BetaConnectorRuleUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## validate-connector-rule Returns a list of issues within the code to fix, if any. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/validate-connector-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -337,10 +355,10 @@ $SourceCode = @"{ try { $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode - Confirm-BetaConnectorRule -BetaSourceCode $Result + Confirm-BetaConnectorRule -BetaSourceCode $Result # Below is a request that includes all optional parameters - # Confirm-BetaConnectorRule -BetaSourceCode $SourceCode + # Confirm-BetaConnectorRule -BetaSourceCode $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorsApi.md index 1df785b57..3e68079dd 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorsApi.md @@ -33,9 +33,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-BetaConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List + ## get-connector-list Fetches list of connectors that have 'RELEASED' status using filtering and pagination. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-connector-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -74,10 +77,10 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale # Get Connector List try { - Get-BetaConnectorList + Get-BetaConnectorList # Below is a request that includes all optional parameters - # Get-BetaConnectorList -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaLocale $Locale + # Get-BetaConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorList" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md index b115be367..e38391a99 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md @@ -45,9 +45,12 @@ Method | HTTP request | Description [**Search-BetaPreDefinedSelectOptions**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options. [**Show-BetaPreviewDataSource**](#show-preview-data-source) | **POST** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source. + ## create-form-definition +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -187,19 +190,22 @@ $CreateFormDefinitionRequest = @"{ # Creates a form definition. try { - New-BetaFormDefinition + New-BetaFormDefinition # Below is a request that includes all optional parameters - # New-BetaFormDefinition -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest + # New-BetaFormDefinition -BetaCreateFormDefinitionRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-form-definition-by-template +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-by-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -339,19 +345,22 @@ $CreateFormDefinitionRequest = @"{ # Create a form definition by template. try { - New-BetaFormDefinitionByTemplate + New-BetaFormDefinitionByTemplate # Below is a request that includes all optional parameters - # New-BetaFormDefinitionByTemplate -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest + # New-BetaFormDefinitionByTemplate -BetaCreateFormDefinitionRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-form-definition-dynamic-schema +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-dynamic-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -390,19 +399,22 @@ $Body = @"{ # Generate JSON Schema dynamically. try { - New-BetaFormDefinitionDynamicSchema + New-BetaFormDefinitionDynamicSchema # Below is a request that includes all optional parameters - # New-BetaFormDefinitionDynamicSchema -BetaBody $Body + # New-BetaFormDefinitionDynamicSchema -BetaBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-form-definition-file-request Parameter `{formDefinitionID}` should match a form definition ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-definition-file-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -438,19 +450,22 @@ $File = # System.IO.FileInfo | File specifying the multipart # Upload new form definition file. try { - New-BetaFormDefinitionFileRequest -BetaFormDefinitionID $FormDefinitionID -BetaFile $File + New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File # Below is a request that includes all optional parameters - # New-BetaFormDefinitionFileRequest -BetaFormDefinitionID $FormDefinitionID -BetaFile $File + # New-BetaFormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionFileRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-form-instance +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-form-instance) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -500,19 +515,22 @@ $Body = @"{ # Creates a form instance. try { - New-BetaFormInstance + New-BetaFormInstance # Below is a request that includes all optional parameters - # New-BetaFormInstance -BetaBody $Body + # New-BetaFormInstance -BetaBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-form-definition Parameter `{formDefinitionID}` should match a form definition ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-form-definition) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -543,19 +561,22 @@ $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form defin # Deletes a form definition. try { - Remove-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID + Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters - # Remove-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID + # Remove-BetaFormDefinition -FormDefinitionID $FormDefinitionID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaFormDefinition" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-form-definitions-by-tenant No parameters required. +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-form-definitions-by-tenant) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -591,19 +612,22 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # List form definitions by tenant. try { - Export-BetaFormDefinitionsByTenant + Export-BetaFormDefinitionsByTenant # Below is a request that includes all optional parameters - # Export-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters + # Export-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaFormDefinitionsByTenant" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-file-from-s3 +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-file-from-s3) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -637,19 +661,22 @@ $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying # Download definition file by fileId. try { - Get-BetaFileFromS3 -BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID + Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID # Below is a request that includes all optional parameters - # Get-BetaFileFromS3 -BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID + # Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFileFromS3" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-form-definition-by-key Parameter `{formDefinitionID}` should match a form definition ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-definition-by-key) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -680,19 +707,22 @@ $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form defin # Return a form definition. try { - Get-BetaFormDefinitionByKey -BetaFormDefinitionID $FormDefinitionID + Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters - # Get-BetaFormDefinitionByKey -BetaFormDefinitionID $FormDefinitionID + # Get-BetaFormDefinitionByKey -FormDefinitionID $FormDefinitionID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormDefinitionByKey" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-form-instance-by-key Parameter `{formInstanceID}` should match a form instance ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-instance-by-key) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -723,19 +753,22 @@ $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instanc # Returns a form instance. try { - Get-BetaFormInstanceByKey -BetaFormInstanceID $FormInstanceID + Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID # Below is a request that includes all optional parameters - # Get-BetaFormInstanceByKey -BetaFormInstanceID $FormInstanceID + # Get-BetaFormInstanceByKey -FormInstanceID $FormInstanceID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceByKey" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-form-instance-file +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-form-instance-file) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -769,19 +802,22 @@ $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying # Download instance file by fileId. try { - Get-BetaFormInstanceFile -BetaFormInstanceID $FormInstanceID -BetaFileID $FileID + Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID # Below is a request that includes all optional parameters - # Get-BetaFormInstanceFile -BetaFormInstanceID $FormInstanceID -BetaFileID $FileID + # Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceFile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-form-definitions +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-form-definitions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -818,19 +854,22 @@ Code | Description | Data Type # Import form definitions from export. try { - Import-BetaFormDefinitions + Import-BetaFormDefinitions # Below is a request that includes all optional parameters - # Import-BetaFormDefinitions -BetaBody $Body + # Import-BetaFormDefinitions -BetaBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-form-definition Parameter `{formDefinitionID}` should match a form definition ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-form-definition) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -865,19 +904,22 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for # Patch a form definition. try { - Update-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID + Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters - # Update-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID -BetaBody $Body + # Update-BetaFormDefinition -FormDefinitionID $FormDefinitionID -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormDefinition" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-form-instance Parameter `{formInstanceID}` should match a form instance ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-form-instance) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -913,19 +955,22 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for # Patch a form instance. try { - Update-BetaFormInstance -BetaFormInstanceID $FormInstanceID + Update-BetaFormInstance -FormInstanceID $FormInstanceID # Below is a request that includes all optional parameters - # Update-BetaFormInstance -BetaFormInstanceID $FormInstanceID -BetaBody $Body + # Update-BetaFormInstance -FormInstanceID $FormInstanceID -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormInstance" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-form-definitions-by-tenant No parameters required. +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-form-definitions-by-tenant) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -961,20 +1006,23 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # Export form definitions by tenant. try { - Search-BetaFormDefinitionsByTenant + Search-BetaFormDefinitionsByTenant # Below is a request that includes all optional parameters - # Search-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters + # Search-BetaFormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormDefinitionsByTenant" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-form-element-data-by-element-id Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-form-element-data-by-element-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1013,19 +1061,22 @@ $Query = "support" # String | String that is passed to the underlying API to fil # Retrieves dynamic data by element. try { - Search-BetaFormElementDataByElementID -BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID + Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID # Below is a request that includes all optional parameters - # Search-BetaFormElementDataByElementID -BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query + # Search-BetaFormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $Query } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormElementDataByElementID" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-form-instances-by-tenant No parameters required. +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-form-instances-by-tenant) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1053,7 +1104,7 @@ Code | Description | Data Type # List form instances by tenant. try { - Search-BetaFormInstancesByTenant + Search-BetaFormInstancesByTenant # Below is a request that includes all optional parameters # Search-BetaFormInstancesByTenant @@ -1063,9 +1114,12 @@ try { } ``` [[Back to top]](#) + ## search-pre-defined-select-options No parameters required. +[API Spec](https://developer.sailpoint.com/docs/api/beta/search-pre-defined-select-options) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1093,7 +1147,7 @@ Code | Description | Data Type # List predefined select options. try { - Search-BetaPreDefinedSelectOptions + Search-BetaPreDefinedSelectOptions # Below is a request that includes all optional parameters # Search-BetaPreDefinedSelectOptions @@ -1103,9 +1157,12 @@ try { } ``` [[Back to top]](#) + ## show-preview-data-source +[API Spec](https://developer.sailpoint.com/docs/api/beta/show-preview-data-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1154,10 +1211,10 @@ $FormElementPreviewRequest = @"{ # Preview form definition data source. try { - Show-BetaPreviewDataSource -BetaFormDefinitionID $FormDefinitionID + Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters - # Show-BetaPreviewDataSource -BetaFormDefinitionID $FormDefinitionID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query -BetaFormElementPreviewRequest $FormElementPreviewRequest + # Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -BetaFormElementPreviewRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaPreviewDataSource" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md index 8da729869..61aafa146 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md @@ -32,9 +32,12 @@ Method | HTTP request | Description [**Remove-BetaCustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID [**Get-BetaCustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID + ## create-custom-password-instructions This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-custom-password-instructions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -67,19 +70,22 @@ $CustomPasswordInstruction = @"{ try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction - New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $Result + New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $Result # Below is a request that includes all optional parameters - # New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $CustomPasswordInstruction + # New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCustomPasswordInstructions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-custom-password-instructions This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-custom-password-instructions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -110,19 +116,22 @@ $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 # Delete Custom Password Instructions by page ID try { - Remove-BetaCustomPasswordInstructions -BetaPageId $PageId + Remove-BetaCustomPasswordInstructions -PageId $PageId # Below is a request that includes all optional parameters - # Remove-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale + # Remove-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCustomPasswordInstructions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-custom-password-instructions This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-custom-password-instructions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -153,10 +162,10 @@ $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 # Get Custom Password Instructions by Page ID try { - Get-BetaCustomPasswordInstructions -BetaPageId $PageId + Get-BetaCustomPasswordInstructions -PageId $PageId # Below is a request that includes all optional parameters - # Get-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale + # Get-BetaCustomPasswordInstructions -PageId $PageId -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomPasswordInstructions" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md index 14f42d40c..eeca2d278 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md @@ -79,9 +79,12 @@ Method | HTTP request | Description [**Reset-BetaSourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{sourceId}` | Reset Source Entitlements [**Update-BetaEntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list + ## create-access-model-metadata-for-entitlement Add single Access Model Metadata to an entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-model-metadata-for-entitlement) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -115,19 +118,22 @@ $AttributeValue = "public" # String | Technical name of the Attribute Value. # Add metadata to an entitlement. try { - New-BetaAccessModelMetadataForEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue # Below is a request that includes all optional parameters - # New-BetaAccessModelMetadataForEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + # New-BetaAccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessModelMetadataForEntitlement" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-access-model-metadata-from-entitlement Remove single Access Model Metadata from an entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-access-model-metadata-from-entitlement) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -161,19 +167,22 @@ $AttributeValue = "public" # String | Technical name of the Attribute Value. # Remove metadata from an entitlement. try { - Remove-BetaAccessModelMetadataFromEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue # Below is a request that includes all optional parameters - # Remove-BetaAccessModelMetadataFromEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + # Remove-BetaAccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessModelMetadataFromEntitlement" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-entitlement This API returns an entitlement by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -204,19 +213,22 @@ $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID # Get an entitlement try { - Get-BetaEntitlement -BetaId $Id + Get-BetaEntitlement -Id $Id # Below is a request that includes all optional parameters - # Get-BetaEntitlement -BetaId $Id + # Get-BetaEntitlement -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlement" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-entitlement-request-config This API returns the entitlement request config for a specified entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -247,23 +259,29 @@ $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id # Get Entitlement Request Config try { - Get-BetaEntitlementRequestConfig -BetaId $Id + Get-BetaEntitlementRequestConfig -Id $Id # Below is a request that includes all optional parameters - # Get-BetaEntitlementRequestConfig -BetaId $Id + # Get-BetaEntitlementRequestConfig -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementRequestConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-entitlements-by-source +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-entitlements-by-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -295,19 +313,22 @@ $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlemen # Aggregate Entitlements try { - Import-BetaEntitlementsBySource -BetaId $Id + Import-BetaEntitlementsBySource -Id $Id # Below is a request that includes all optional parameters - # Import-BetaEntitlementsBySource -BetaId $Id -BetaCsvFile $CsvFile + # Import-BetaEntitlementsBySource -Id $Id -CsvFile $CsvFile } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlementsBySource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-entitlement-children This API returns a list of all child entitlements of a given entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlement-children) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -348,19 +369,22 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar # List of entitlements children try { - Get-BetaEntitlementChildren -BetaId $Id + Get-BetaEntitlementChildren -Id $Id # Below is a request that includes all optional parameters - # Get-BetaEntitlementChildren -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaEntitlementChildren -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChildren" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-entitlement-parents This API returns a list of all parent entitlements of a given entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlement-parents) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -401,16 +425,17 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar # List of entitlements parents try { - Get-BetaEntitlementParents -BetaId $Id + Get-BetaEntitlementParents -Id $Id # Below is a request that includes all optional parameters - # Get-BetaEntitlementParents -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaEntitlementParents -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementParents" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-entitlements This API returns a list of entitlements. @@ -418,6 +443,8 @@ This API can be used in one of the two following ways: either getting entitlemen Any authenticated token can call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -463,16 +490,17 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar # Gets a list of entitlements. try { - Get-BetaEntitlements + Get-BetaEntitlements # Below is a request that includes all optional parameters - # Get-BetaEntitlements -BetaAccountId $AccountId -BetaSegmentedForIdentity $SegmentedForIdentity -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaEntitlements -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-entitlement This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. @@ -482,6 +510,8 @@ When you're patching owner, only owner type and owner id must be provided. Owner A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-entitlement) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -519,19 +549,22 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to pat # Patch an entitlement try { - Update-BetaEntitlement -BetaId $Id + Update-BetaEntitlement -Id $Id # Below is a request that includes all optional parameters - # Update-BetaEntitlement -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaEntitlement -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-entitlement-request-config This API replaces the entitlement request config for a specified entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-entitlement-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -577,20 +610,23 @@ $EntitlementRequestConfig = @"{ try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig - Send-BetaEntitlementRequestConfig -BetaId $Id -BetaEntitlementRequestConfig $Result + Send-BetaEntitlementRequestConfig -Id $Id -BetaEntitlementRequestConfig $Result # Below is a request that includes all optional parameters - # Send-BetaEntitlementRequestConfig -BetaId $Id -BetaEntitlementRequestConfig $EntitlementRequestConfig + # Send-BetaEntitlementRequestConfig -Id $Id -BetaEntitlementRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reset-source-entitlements Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`. +[API Spec](https://developer.sailpoint.com/docs/api/beta/reset-source-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -620,16 +656,17 @@ $SourceId = "2c91808a7813090a017814121919ecca" # String | ID of source for the e # Reset Source Entitlements try { - Reset-BetaSourceEntitlements -BetaSourceId $SourceId + Reset-BetaSourceEntitlements -SourceId $SourceId # Below is a request that includes all optional parameters - # Reset-BetaSourceEntitlements -BetaSourceId $SourceId + # Reset-BetaSourceEntitlements -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaSourceEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-entitlements-in-bulk This API applies an update to every entitlement of the list. @@ -646,6 +683,8 @@ Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : A token with ORG_ADMIN or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-entitlements-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -687,10 +726,10 @@ $EntitlementBulkUpdateRequest = @"{ try { $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest - Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $Result + Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $Result # Below is a request that includes all optional parameters - # Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $EntitlementBulkUpdateRequest + # Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsInBulk" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md index b13912366..0712cfa73 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md @@ -33,9 +33,12 @@ Method | HTTP request | Description [**Update-BetaWorkgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group [**Update-BetaWorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group + ## create-workgroup This API creates a new Governance Group. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-workgroup) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -81,19 +84,22 @@ $WorkgroupDto = @"{ try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto - New-BetaWorkgroup -BetaWorkgroupDto $Result + New-BetaWorkgroup -BetaWorkgroupDto $Result # Below is a request that includes all optional parameters - # New-BetaWorkgroup -BetaWorkgroupDto $WorkgroupDto + # New-BetaWorkgroup -BetaWorkgroupDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-workgroup This API deletes a Governance Group by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroup) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -123,16 +129,17 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group # Delete a Governance Group try { - Remove-BetaWorkgroup -BetaId $Id + Remove-BetaWorkgroup -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaWorkgroup -BetaId $Id + # Remove-BetaWorkgroup -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-workgroup-members This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. @@ -140,6 +147,8 @@ This API removes one or more members from a Governance Group. A token with API > **name** +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroup-members) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -173,16 +182,17 @@ $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governanc try { $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner - Remove-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result # Below is a request that includes all optional parameters - # Remove-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner + # Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-workgroups-in-bulk This API initiates a bulk deletion of one or more Governance Groups. @@ -197,6 +207,8 @@ This API initiates a bulk deletion of one or more Governance Groups. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workgroups-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -229,19 +241,22 @@ $WorkgroupBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest - Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $Result + Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest + # Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-workgroup This API returns a Governance Groups by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workgroup) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -271,19 +286,22 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group # Get Governance Group by Id try { - Get-BetaWorkgroup -BetaId $Id + Get-BetaWorkgroup -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkgroup -BetaId $Id + # Get-BetaWorkgroup -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-connections This API returns list of connections associated with a Governance Group. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-connections) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -321,19 +339,22 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List connections for Governance Group try { - Get-BetaConnections -BetaWorkgroupId $WorkgroupId + Get-BetaConnections -WorkgroupId $WorkgroupId # Below is a request that includes all optional parameters - # Get-BetaConnections -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters + # Get-BetaConnections -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnections" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-workgroup-members This API returns list of members associated with a Governance Group. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workgroup-members) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -371,19 +392,22 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List Governance Group Members try { - Get-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId + Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId # Below is a request that includes all optional parameters - # Get-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters + # Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroupMembers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-workgroups This API returns list of Governance Groups +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workgroups) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -421,16 +445,17 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List Governance Groups try { - Get-BetaWorkgroups + Get-BetaWorkgroups # Below is a request that includes all optional parameters - # Get-BetaWorkgroups -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaWorkgroups -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroups" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-workgroup This API updates an existing governance group by ID. The following fields and objects are patchable: @@ -440,6 +465,8 @@ The following fields and objects are patchable: A token with API or ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-workgroup) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -476,16 +503,17 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group # Patch a Governance Group try { - Update-BetaWorkgroup -BetaId $Id + Update-BetaWorkgroup -Id $Id # Below is a request that includes all optional parameters - # Update-BetaWorkgroup -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaWorkgroup -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-workgroup-members This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. @@ -493,6 +521,8 @@ This API adds one or more members to a Governance Group. A token with API, ORG_ > **name** +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-workgroup-members) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -526,10 +556,10 @@ $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governanc try { $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner - Update-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner + # Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroupMembers" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md index fd27854af..385be8d41 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md @@ -26,9 +26,12 @@ Method | HTTP request | Description [**Get-BetaAccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations [**Get-BetaAccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations + ## add-access-request-recommendations-ignored-item This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-ignored-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -65,19 +68,22 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $Result + Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + # Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## add-access-request-recommendations-requested-item This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-requested-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -114,19 +120,22 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $Result + Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + # Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## add-access-request-recommendations-viewed-item This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -163,19 +172,22 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $Result + Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + # Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## add-access-request-recommendations-viewed-items This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -213,19 +225,22 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $Result + Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + # Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-recommendations This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -267,19 +282,22 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ # Identity Access Request Recommendations try { - Get-BetaAccessRequestRecommendations + Get-BetaAccessRequestRecommendations # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendations -BetaIdentityId $IdentityId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaAccessRequestRecommendations -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-recommendations-ignored-items This API returns the list of ignored access request recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-ignored-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -317,19 +335,22 @@ $Sorters = "access.id" # String | Sort results using the standard syntax describ # List of Ignored Access Request Recommendations try { - Get-BetaAccessRequestRecommendationsIgnoredItems + Get-BetaAccessRequestRecommendationsIgnoredItems # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendationsIgnoredItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaAccessRequestRecommendationsIgnoredItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsIgnoredItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-recommendations-requested-items This API returns a list of requested access request recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-requested-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -367,19 +388,22 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ # List of Requested Access Request Recommendations try { - Get-BetaAccessRequestRecommendationsRequestedItems + Get-BetaAccessRequestRecommendationsRequestedItems # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendationsRequestedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaAccessRequestRecommendationsRequestedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsRequestedItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-recommendations-viewed-items This API returns the list of viewed access request recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-viewed-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -417,10 +441,10 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ # List of Viewed Access Request Recommendations try { - Get-BetaAccessRequestRecommendationsViewedItems + Get-BetaAccessRequestRecommendationsViewedItems # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendationsViewedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaAccessRequestRecommendationsViewedItems -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAICommonAccessApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAICommonAccessApi.md index bed73f56a..1cabbf235 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAICommonAccessApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAICommonAccessApi.md @@ -21,9 +21,12 @@ Method | HTTP request | Description [**Get-BetaCommonAccess**](#get-common-access) | **GET** `/common-access` | Get a paginated list of common access [**Update-BetaCommonAccessStatusInBulk**](#update-common-access-status-in-bulk) | **POST** `/common-access/update-status` | Bulk update common access status + ## create-common-access This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-common-access) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -64,19 +67,22 @@ $CommonAccessItemRequest = @"{ try { $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest - New-BetaCommonAccess -BetaCommonAccessItemRequest $Result + New-BetaCommonAccess -BetaCommonAccessItemRequest $Result # Below is a request that includes all optional parameters - # New-BetaCommonAccess -BetaCommonAccessItemRequest $CommonAccessItemRequest + # New-BetaCommonAccess -BetaCommonAccessItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-common-access This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-common-access) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -113,19 +119,22 @@ $Sorters = "access.name" # String | Sort results using the standard syntax descr # Get a paginated list of common access try { - Get-BetaCommonAccess + Get-BetaCommonAccess # Below is a request that includes all optional parameters - # Get-BetaCommonAccess -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaCommonAccess -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-common-access-status-in-bulk This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-common-access-status-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -160,10 +169,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus - Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $Result + Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $Result # Below is a request that includes all optional parameters - # Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $CommonAccessIDStatus + # Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIMessageCatalogsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIMessageCatalogsApi.md index 7d8d55a41..daf47eec6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIMessageCatalogsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIMessageCatalogsApi.md @@ -19,9 +19,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-BetaMessageCatalogs**](#get-message-catalogs) | **GET** `/translation-catalogs/{catalog-id}` | Get Message catalogs + ## get-message-catalogs The getMessageCatalogs API returns message catalog based on the language headers in the requested object. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-message-catalogs) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -51,10 +54,10 @@ $CatalogId = "recommender" # String | The ID of the message catalog. # Get Message catalogs try { - Get-BetaMessageCatalogs -BetaCatalogId $CatalogId + Get-BetaMessageCatalogs -CatalogId $CatalogId # Below is a request that includes all optional parameters - # Get-BetaMessageCatalogs -BetaCatalogId $CatalogId + # Get-BetaMessageCatalogs -CatalogId $CatalogId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMessageCatalogs" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md index 2f815c802..b8fb08549 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md @@ -27,12 +27,15 @@ Method | HTTP request | Description [**Get-BetaOutliersContributingFeatureAccessItems**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature [**Invoke-BetaUnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore + ## export-outliers-zip This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-outliers-zip) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -62,19 +65,22 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi # IAI Identity Outliers Export try { - Export-BetaOutliersZip + Export-BetaOutliersZip # Below is a request that includes all optional parameters - # Export-BetaOutliersZip -BetaType $Type + # Export-BetaOutliersZip -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-outlier-snapshots This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-outlier-snapshots) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -113,19 +119,22 @@ $Sorters = "snapshotDate" # String | Sort results using the standard syntax desc # IAI Identity Outliers Summary try { - Get-BetaIdentityOutlierSnapshots + Get-BetaIdentityOutlierSnapshots # Below is a request that includes all optional parameters - # Get-BetaIdentityOutlierSnapshots -BetaLimit $Limit -BetaOffset $Offset -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaIdentityOutlierSnapshots -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-outliers This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-outliers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -165,19 +174,22 @@ $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort re # IAI Get Identity Outliers try { - Get-BetaIdentityOutliers + Get-BetaIdentityOutliers # Below is a request that includes all optional parameters - # Get-BetaIdentityOutliers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaIdentityOutliers -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-latest-identity-outlier-snapshots This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-latest-identity-outlier-snapshots) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -208,22 +220,25 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi # IAI Identity Outliers Latest Summary try { - Get-BetaLatestIdentityOutlierSnapshots + Get-BetaLatestIdentityOutlierSnapshots # Below is a request that includes all optional parameters - # Get-BetaLatestIdentityOutlierSnapshots -BetaType $Type + # Get-BetaLatestIdentityOutlierSnapshots -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-outlier-contributing-feature-summary This API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-outlier-contributing-feature-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -254,22 +269,25 @@ $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributi # Get identity outlier contibuting feature summary try { - Get-BetaOutlierContributingFeatureSummary -BetaOutlierFeatureId $OutlierFeatureId + Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId # Below is a request that includes all optional parameters - # Get-BetaOutlierContributingFeatureSummary -BetaOutlierFeatureId $OutlierFeatureId + # Get-BetaOutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-peer-group-outliers-contributing-features This API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-peer-group-outliers-contributing-features) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -310,19 +328,22 @@ $Sorters = "importance" # String | Sort results using the standard syntax descri # Get identity outlier's contibuting features try { - Get-BetaPeerGroupOutliersContributingFeatures -BetaOutlierId $OutlierId + Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId # Below is a request that includes all optional parameters - # Get-BetaPeerGroupOutliersContributingFeatures -BetaOutlierId $OutlierId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaSorters $Sorters + # Get-BetaPeerGroupOutliersContributingFeatures -OutlierId $OutlierId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## ignore-identity-outliers This API receives a list of identity IDs in the request, changes the outliers to be ignored. +[API Spec](https://developer.sailpoint.com/docs/api/beta/ignore-identity-outliers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -355,22 +376,25 @@ $RequestBody = "MyRequestBody" # String[] | try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-BetaIgnoreIdentityOutliers -BetaRequestBody $Result + Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result # Below is a request that includes all optional parameters - # Invoke-BetaIgnoreIdentityOutliers -BetaRequestBody $RequestBody + # Invoke-BetaIgnoreIdentityOutliers -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-outliers-contributing-feature-access-items This API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-outliers-contributing-feature-access-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -413,19 +437,22 @@ $Sorters = "displayName" # String | Sort results using the standard syntax descr # Gets a list of access items associated with each identity outlier contributing feature try { - Get-BetaOutliersContributingFeatureAccessItems -BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName + Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName # Below is a request that includes all optional parameters - # Get-BetaOutliersContributingFeatureAccessItems -BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaAccessType $AccessType -BetaSorters $Sorters + # Get-BetaOutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## un-ignore-identity-outliers This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. +[API Spec](https://developer.sailpoint.com/docs/api/beta/un-ignore-identity-outliers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -458,10 +485,10 @@ $RequestBody = "MyRequestBody" # String[] | try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-BetaUnIgnoreIdentityOutliers -BetaRequestBody $Result + Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result # Below is a request that includes all optional parameters - # Invoke-BetaUnIgnoreIdentityOutliers -BetaRequestBody $RequestBody + # Invoke-BetaUnIgnoreIdentityOutliers -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIPeerGroupStrategiesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIPeerGroupStrategiesApi.md index 5063600d7..674a68a04 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIPeerGroupStrategiesApi.md @@ -19,9 +19,15 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-BetaPeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List + ## get-peer-group-outliers +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: -- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-peer-group-outliers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -57,10 +63,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Identity Outliers List try { - Get-BetaPeerGroupOutliers -BetaStrategy $Strategy + Get-BetaPeerGroupOutliers -Strategy $Strategy # Below is a request that includes all optional parameters - # Get-BetaPeerGroupOutliers -BetaStrategy $Strategy -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + # Get-BetaPeerGroupOutliers -Strategy $Strategy -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliers" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md index 4b34d8709..4421e5e3e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md @@ -21,9 +21,12 @@ Method | HTTP request | Description [**Get-BetaRecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values [**Update-BetaRecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values + ## get-recommendations The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-recommendations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -72,19 +75,22 @@ $RecommendationRequestDto = @"{ try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto - Get-BetaRecommendations -BetaRecommendationRequestDto $Result + Get-BetaRecommendations -BetaRecommendationRequestDto $Result # Below is a request that includes all optional parameters - # Get-BetaRecommendations -BetaRecommendationRequestDto $RecommendationRequestDto + # Get-BetaRecommendations -BetaRecommendationRequestDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-recommendations-config Retrieves configuration attributes used by certification recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-recommendations-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -111,7 +117,7 @@ Code | Description | Data Type # Get certification recommendation config values try { - Get-BetaRecommendationsConfig + Get-BetaRecommendationsConfig # Below is a request that includes all optional parameters # Get-BetaRecommendationsConfig @@ -121,9 +127,12 @@ try { } ``` [[Back to top]](#) + ## update-recommendations-config Updates configuration attributes used by certification recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-recommendations-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -158,10 +167,10 @@ $RecommendationConfigDto = @"{ try { $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto - Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $Result + Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $Result # Below is a request that includes all optional parameters - # Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $RecommendationConfigDto + # Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md index a29cc545c..f6d5fcc4e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md @@ -43,9 +43,12 @@ Method | HTTP request | Description [**Update-BetaRoleMiningSession**](#patch-role-mining-session) | **PATCH** `/role-mining-sessions/{sessionId}` | Patch a role mining session [**Update-BetaEntitlementsPotentialRole**](#update-entitlements-potential-role) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements + ## create-potential-role-provision-request This method starts a job to provision a potential role +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-potential-role-provision-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -89,19 +92,22 @@ $RoleMiningPotentialRoleProvisionRequest = @"{ # Create request to provision a potential role into an actual role. try { - New-BetaPotentialRoleProvisionRequest -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # New-BetaPotentialRoleProvisionRequest -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaMinEntitlementPopularity $MinEntitlementPopularity -BetaIncludeCommonAccess $IncludeCommonAccess -BetaRoleMiningPotentialRoleProvisionRequest $RoleMiningPotentialRoleProvisionRequest + # New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -BetaRoleMiningPotentialRoleProvisionRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-role-mining-sessions This submits a create role mining session request to the role mining application. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-role-mining-sessions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -163,19 +169,22 @@ $RoleMiningSessionDto = @"{ try { $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto - New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $Result + New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $Result # Below is a request that includes all optional parameters - # New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $RoleMiningSessionDto + # New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## download-role-mining-potential-role-zip This endpoint downloads a completed export of information for a potential role in a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/beta/download-role-mining-potential-role-zip) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -208,19 +217,22 @@ $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previo # Export (download) details for a potential role in a role mining session try { - Invoke-BetaDownloadRoleMiningPotentialRoleZip -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId # Below is a request that includes all optional parameters - # Invoke-BetaDownloadRoleMiningPotentialRoleZip -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + # Invoke-BetaDownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleMiningPotentialRoleZip" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-role-mining-potential-role This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -251,19 +263,22 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential # Export (download) details for a potential role in a role mining session try { - Export-BetaRoleMiningPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # Export-BetaRoleMiningPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + # Export-BetaRoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-role-mining-potential-role-async This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role-async) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -299,19 +314,22 @@ $RoleMiningPotentialRoleExportRequest = @"{ # Asynchronously export details for a potential role in a role mining session and upload to S3 try { - Export-BetaRoleMiningPotentialRoleAsync -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # Export-BetaRoleMiningPotentialRoleAsync -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleExportRequest $RoleMiningPotentialRoleExportRequest + # Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleExportRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-role-mining-potential-role-status This endpoint retrieves information about the current status of a potential role export. +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-role-mining-potential-role-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -344,19 +362,22 @@ $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previo # Retrieve status of a potential role export job try { - Export-BetaRoleMiningPotentialRoleStatus -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId # Below is a request that includes all optional parameters - # Export-BetaRoleMiningPotentialRoleStatus -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + # Export-BetaRoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-all-potential-role-summaries Returns all potential role summaries that match the query parameters +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-all-potential-role-summaries) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -394,19 +415,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves all potential role summaries try { - Get-BetaAllPotentialRoleSummaries + Get-BetaAllPotentialRoleSummaries # Below is a request that includes all optional parameters - # Get-BetaAllPotentialRoleSummaries -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaAllPotentialRoleSummaries -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllPotentialRoleSummaries" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-entitlement-distribution-potential-role This method returns entitlement popularity distribution for a potential role in a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-distribution-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -439,19 +463,22 @@ $IncludeCommonAccess = $true # Boolean | Boolean determining whether common acce # Retrieves entitlement popularity distribution for a potential role in a role mining session try { - Get-BetaEntitlementDistributionPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # Get-BetaEntitlementDistributionPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess + # Get-BetaEntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementDistributionPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-entitlements-potential-role This method returns entitlements for a potential role in a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlements-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -495,19 +522,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves entitlements for a potential role in a role mining session try { - Get-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # Get-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementsPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-excluded-entitlements-potential-role This method returns excluded entitlements for a potential role in a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-excluded-entitlements-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -548,19 +578,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves excluded entitlements for a potential role in a role mining session try { - Get-BetaExcludedEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # Get-BetaExcludedEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaExcludedEntitlementsPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identities-potential-role This method returns identities for a potential role in a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identities-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -601,19 +634,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves identities for a potential role in a role mining session try { - Get-BetaIdentitiesPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # Get-BetaIdentitiesPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaIdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitiesPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-potential-role This method returns a specific potential role for a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -645,19 +681,22 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential # Retrieve potential role in session try { - Get-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # Get-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + # Get-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-potential-role-applications This method returns the applications of a potential role for a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-applications) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -697,19 +736,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves the applications of a potential role for a role mining session try { - Get-BetaPotentialRoleApplications -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleApplications -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaPotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleApplications" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-potential-role-entitlements This method returns the entitlements of a potential role for a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -749,19 +791,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves the entitlements of a potential role for a role mining session try { - Get-BetaPotentialRoleEntitlements -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleEntitlements -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaPotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-potential-role-source-identity-usage This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-source-identity-usage) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -801,19 +846,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves potential role source usage try { - Get-BetaPotentialRoleSourceIdentityUsage -BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId + Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleSourceIdentityUsage -BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaPotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSourceIdentityUsage" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-potential-role-summaries This method returns the potential role summaries for a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-potential-role-summaries) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -853,19 +901,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieve session's potential role summaries try { - Get-BetaPotentialRoleSummaries -BetaSessionId $SessionId + Get-BetaPotentialRoleSummaries -SessionId $SessionId # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleSummaries -BetaSessionId $SessionId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaPotentialRoleSummaries -SessionId $SessionId -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSummaries" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-mining-potential-role This method returns a specific potential role. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -895,19 +946,22 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential # Retrieves a specific potential role try { - Get-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId + Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # Get-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId + # Get-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-mining-session The method retrieves a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-session) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -938,19 +992,22 @@ $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining s # Get a role mining session try { - Get-BetaRoleMiningSession -BetaSessionId $SessionId + Get-BetaRoleMiningSession -SessionId $SessionId # Below is a request that includes all optional parameters - # Get-BetaRoleMiningSession -BetaSessionId $SessionId + # Get-BetaRoleMiningSession -SessionId $SessionId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSession" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-mining-session-status This method returns a role mining session status for a customer. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-session-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -979,19 +1036,22 @@ $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining s # Get role mining session status state try { - Get-BetaRoleMiningSessionStatus -BetaSessionId $SessionId + Get-BetaRoleMiningSessionStatus -SessionId $SessionId # Below is a request that includes all optional parameters - # Get-BetaRoleMiningSessionStatus -BetaSessionId $SessionId + # Get-BetaRoleMiningSessionStatus -SessionId $SessionId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessionStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-mining-sessions Returns all role mining sessions that match the query parameters +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-mining-sessions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1029,19 +1089,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves all role mining sessions try { - Get-BetaRoleMiningSessions + Get-BetaRoleMiningSessions # Below is a request that includes all optional parameters - # Get-BetaRoleMiningSessions -BetaFilters $Filters -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaRoleMiningSessions -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-saved-potential-roles This method returns all saved potential roles (draft roles). +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-saved-potential-roles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1077,16 +1140,17 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves all saved potential roles try { - Get-BetaSavedPotentialRoles + Get-BetaSavedPotentialRoles # Below is a request that includes all optional parameters - # Get-BetaSavedPotentialRoles -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaSavedPotentialRoles -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSavedPotentialRoles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-potential-role This method updates an existing potential role using the role mining session id and the potential role summary id. @@ -1102,6 +1166,8 @@ The following fields can be modified: >**NOTE: All other fields cannot be modified.** +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1138,16 +1204,17 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potenti try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + # Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-role-mining-potential-role This method updates an existing potential role. @@ -1163,6 +1230,8 @@ The following fields can be modified: >**NOTE: All other fields cannot be modified.** +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-role-mining-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1197,19 +1266,22 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potenti try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + # Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-role-mining-session The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-role-mining-session) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1248,19 +1320,22 @@ $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining s try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaRoleMiningSession -BetaSessionId $SessionId -BetaJsonPatchOperation $Result + Update-BetaRoleMiningSession -SessionId $SessionId -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaRoleMiningSession -BetaSessionId $SessionId -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaRoleMiningSession -SessionId $SessionId -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-entitlements-potential-role This endpoint adds or removes entitlements from an exclusion list for a potential role. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-entitlements-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1297,10 +1372,10 @@ $RoleMiningPotentialRoleEditEntitlements = @"{ try { $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements - Update-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result + Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result # Below is a request that includes all optional parameters - # Update-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $RoleMiningPotentialRoleEditEntitlements + # Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsPotentialRole" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIconsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIconsApi.md index e1dbadd52..342d56b52 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIconsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIconsApi.md @@ -22,9 +22,12 @@ Method | HTTP request | Description [**Remove-BetaIcon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon [**Set-BetaIcon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon + ## delete-icon This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-icon) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -57,19 +60,22 @@ $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. # Delete an icon try { - Remove-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId + Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId # Below is a request that includes all optional parameters - # Remove-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId + # Remove-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-icon This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-icon) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -104,10 +110,10 @@ $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png' # Update an icon try { - Set-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image + Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image # Below is a request that includes all optional parameters - # Set-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image + # Set-BetaIcon -ObjectType $ObjectType -ObjectId $ObjectId -Image $Image } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md index decc58bfb..c7d2a3210 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md @@ -44,9 +44,12 @@ Method | HTTP request | Description [**Start-BetaIdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds [**Sync-BetahronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. + ## delete-identity The API returns successful response if the requested identity was deleted. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -77,19 +80,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id # Delete identity try { - Remove-BetaIdentity -BetaId $Id + Remove-BetaIdentity -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaIdentity -BetaId $Id + # Remove-BetaIdentity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity This API returns a single identity using the Identity ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -120,21 +126,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id # Identity Details try { - Get-BetaIdentity -BetaId $Id + Get-BetaIdentity -Id $Id # Below is a request that includes all optional parameters - # Get-BetaIdentity -BetaId $Id + # Get-BetaIdentity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-ownership-details Use this API to return an identity's owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-ownership-details) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -165,19 +174,22 @@ $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. # Get ownership details try { - Get-BetaIdentityOwnershipDetails -BetaIdentityId $IdentityId + Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId # Below is a request that includes all optional parameters - # Get-BetaIdentityOwnershipDetails -BetaIdentityId $IdentityId + # Get-BetaIdentityOwnershipDetails -IdentityId $IdentityId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOwnershipDetails" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-assignment +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assignment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -210,19 +222,22 @@ $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id # Role assignment details try { - Get-BetaRoleAssignment -BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId + Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId # Below is a request that includes all optional parameters - # Get-BetaRoleAssignment -BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId + # Get-BetaRoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-assignments This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assignments) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -257,19 +272,22 @@ $RoleName = "Engineer" # String | Role name to filter the role assignments with # List role assignments try { - Get-BetaRoleAssignments -BetaIdentityId $IdentityId + Get-BetaRoleAssignments -IdentityId $IdentityId # Below is a request that includes all optional parameters - # Get-BetaRoleAssignments -BetaIdentityId $IdentityId -BetaRoleId $RoleId -BetaRoleName $RoleName + # Get-BetaRoleAssignments -IdentityId $IdentityId -RoleId $RoleId -RoleName $RoleName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignments" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identities This API returns a list of identities. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -309,19 +327,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # List Identities try { - Get-BetaIdentities + Get-BetaIdentities # Below is a request that includes all optional parameters - # Get-BetaIdentities -BetaFilters $Filters -BetaSorters $Sorters -BetaDefaultFilter $DefaultFilter -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset + # Get-BetaIdentities -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reset-identity Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. +[API Spec](https://developer.sailpoint.com/docs/api/beta/reset-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -352,20 +373,23 @@ $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id # Reset an identity try { - Reset-BetaIdentity -BetaIdentityId $IdentityId + Reset-BetaIdentity -IdentityId $IdentityId # Below is a request that includes all optional parameters - # Reset-BetaIdentity -BetaIdentityId $IdentityId + # Reset-BetaIdentity -IdentityId $IdentityId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaIdentity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-identity-verification-account-token This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-identity-verification-account-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -402,16 +426,17 @@ $SendAccountVerificationRequest = @"{ try { $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest - Send-BetaIdentityVerificationAccountToken -BetaId $Id -BetaSendAccountVerificationRequest $Result + Send-BetaIdentityVerificationAccountToken -Id $Id -BetaSendAccountVerificationRequest $Result # Below is a request that includes all optional parameters - # Send-BetaIdentityVerificationAccountToken -BetaId $Id -BetaSendAccountVerificationRequest $SendAccountVerificationRequest + # Send-BetaIdentityVerificationAccountToken -Id $Id -BetaSendAccountVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-identities-invite This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. @@ -420,6 +445,8 @@ This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-identities-invite) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -454,16 +481,17 @@ $InviteIdentitiesRequest = @"{ try { $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest - Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $Result + Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $Result # Below is a request that includes all optional parameters - # Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $InviteIdentitiesRequest + # Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-identity-processing This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. @@ -477,6 +505,8 @@ This endpoint will perform the following tasks: A token with ORG_ADMIN or HELPDESK authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-identity-processing) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -510,19 +540,22 @@ $ProcessIdentitiesRequest = @"{ try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest - Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $Result + Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $Result # Below is a request that includes all optional parameters - # Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $ProcessIdentitiesRequest + # Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## synchronize-attributes-for-identity This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/synchronize-attributes-for-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -553,10 +586,10 @@ $IdentityId = "MyIdentityId" # String | The Identity id # Attribute synchronization for single identity. try { - Sync-BetahronizeAttributesForIdentity -BetaIdentityId $IdentityId + Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId # Below is a request that includes all optional parameters - # Sync-BetahronizeAttributesForIdentity -BetaIdentityId $IdentityId + # Sync-BetahronizeAttributesForIdentity -IdentityId $IdentityId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetahronizeAttributesForIdentity" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md index 8959342a2..33d4b4cbb 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md @@ -24,9 +24,12 @@ Method | HTTP request | Description [**Get-BetaIdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes [**Send-BetaIdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute + ## create-identity-attribute Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -79,19 +82,22 @@ $IdentityAttribute = @"{ try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - New-BetaIdentityAttribute -BetaIdentityAttribute $Result + New-BetaIdentityAttribute -BetaIdentityAttribute $Result # Below is a request that includes all optional parameters - # New-BetaIdentityAttribute -BetaIdentityAttribute $IdentityAttribute + # New-BetaIdentityAttribute -BetaIdentityAttribute $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-identity-attribute This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -122,19 +128,22 @@ $Name = "displayName" # String | The attribute's technical name. # Delete Identity Attribute try { - Remove-BetaIdentityAttribute -BetaName $Name + Remove-BetaIdentityAttribute -Name $Name # Below is a request that includes all optional parameters - # Remove-BetaIdentityAttribute -BetaName $Name + # Remove-BetaIdentityAttribute -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-identity-attributes-in-bulk Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attributes-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -168,19 +177,22 @@ $IdentityAttributeNames = @"{ try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames - Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $Result + Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $Result # Below is a request that includes all optional parameters - # Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $IdentityAttributeNames + # Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-attribute This gets an identity attribute for a given technical name. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -211,19 +223,22 @@ $Name = "displayName" # String | The attribute's technical name. # Get Identity Attribute try { - Get-BetaIdentityAttribute -BetaName $Name + Get-BetaIdentityAttribute -Name $Name # Below is a request that includes all optional parameters - # Get-BetaIdentityAttribute -BetaName $Name + # Get-BetaIdentityAttribute -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-attributes Use this API to get a collection of identity attributes. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -259,19 +274,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List Identity Attributes try { - Get-BetaIdentityAttributes + Get-BetaIdentityAttributes # Below is a request that includes all optional parameters - # Get-BetaIdentityAttributes -BetaIncludeSystem $IncludeSystem -BetaIncludeSilent $IncludeSilent -BetaSearchableOnly $SearchableOnly -BetaCount $Count + # Get-BetaIdentityAttributes -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-identity-attribute This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-identity-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -326,10 +344,10 @@ $IdentityAttribute = @"{ try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - Send-BetaIdentityAttribute -BetaName $Name -BetaIdentityAttribute $Result + Send-BetaIdentityAttribute -Name $Name -BetaIdentityAttribute $Result # Below is a request that includes all optional parameters - # Send-BetaIdentityAttribute -BetaName $Name -BetaIdentityAttribute $IdentityAttribute + # Send-BetaIdentityAttribute -Name $Name -BetaIdentityAttribute $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md index f567eb9d2..63581d097 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md @@ -29,9 +29,12 @@ Method | HTTP request | Description [**Get-BetaIdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Get Identity Access Items Snapshot [**Get-BetaIdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity + ## compare-identity-snapshots This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/beta/compare-identity-snapshots) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -75,19 +78,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Gets a difference of count for each access item types for the given identity between 2 snapshots try { - Compare-BetaIdentitySnapshots -BetaId $Id + Compare-BetaIdentitySnapshots -Id $Id # Below is a request that includes all optional parameters - # Compare-BetaIdentitySnapshots -BetaId $Id -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + # Compare-BetaIdentitySnapshots -Id $Id -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshots" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## compare-identity-snapshots-access-type This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/beta/compare-identity-snapshots-access-type) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -131,19 +137,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Gets a list of differences of specific accessType for the given identity between 2 snapshots try { - Compare-BetaIdentitySnapshotsAccessType -BetaId $Id -BetaAccessType $AccessType + Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType # Below is a request that includes all optional parameters - # Compare-BetaIdentitySnapshotsAccessType -BetaId $Id -BetaAccessType $AccessType -BetaAccessAssociated $AccessAssociated -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + # Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshotsAccessType" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-historical-identity This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-historical-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -173,19 +182,22 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id # Get latest snapshot of identity try { - Get-BetaHistoricalIdentity -BetaId $Id + Get-BetaHistoricalIdentity -Id $Id # Below is a request that includes all optional parameters - # Get-BetaHistoricalIdentity -BetaId $Id + # Get-BetaHistoricalIdentity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-historical-identity-events This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-historical-identity-events) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -232,19 +244,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Lists all events for the given identity try { - Get-BetaHistoricalIdentityEvents -BetaId $Id + Get-BetaHistoricalIdentityEvents -Id $Id # Below is a request that includes all optional parameters - # Get-BetaHistoricalIdentityEvents -BetaId $Id -BetaFrom $From -BetaEventTypes $EventTypes -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + # Get-BetaHistoricalIdentityEvents -Id $Id -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentityEvents" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-snapshot This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-snapshot) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -276,19 +291,22 @@ $Date = "2007-03-01T13:00:00Z" # String | The specified date # Gets an identity snapshot at a given date try { - Get-BetaIdentitySnapshot -BetaId $Id -BetaDate $Date + Get-BetaIdentitySnapshot -Id $Id -Date $Date # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshot -BetaId $Id -BetaDate $Date + # Get-BetaIdentitySnapshot -Id $Id -Date $Date } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshot" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-snapshot-summary This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-snapshot-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -330,19 +348,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Gets the summary for the event count for a specific identity try { - Get-BetaIdentitySnapshotSummary -BetaId $Id + Get-BetaIdentitySnapshotSummary -Id $Id # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshotSummary -BetaId $Id -BetaBefore $Before -BetaInterval $Interval -BetaTimeZone $TimeZone -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + # Get-BetaIdentitySnapshotSummary -Id $Id -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-start-date This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-start-date) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -372,19 +393,22 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id # Gets the start date of the identity try { - Get-BetaIdentityStartDate -BetaId $Id + Get-BetaIdentityStartDate -Id $Id # Below is a request that includes all optional parameters - # Get-BetaIdentityStartDate -BetaId $Id + # Get-BetaIdentityStartDate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityStartDate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-historical-identities This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-historical-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -422,19 +446,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # Lists all the identities try { - Get-BetaHistoricalIdentities + Get-BetaHistoricalIdentities # Below is a request that includes all optional parameters - # Get-BetaHistoricalIdentities -BetaStartsWithQuery $StartsWithQuery -BetaIsDeleted $IsDeleted -BetaIsActive $IsActive -BetaLimit $Limit -BetaOffset $Offset + # Get-BetaHistoricalIdentities -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-access-items This method retrieves a list of access item for the identity filtered by the access item type +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-access-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -479,19 +506,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # List Access Items by Identity try { - Get-BetaIdentityAccessItems -BetaId $Id + Get-BetaIdentityAccessItems -Id $Id # Below is a request that includes all optional parameters - # Get-BetaIdentityAccessItems -BetaId $Id -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters -BetaQuery $Query -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset + # Get-BetaIdentityAccessItems -Id $Id -Type $Type -Filters $Filters -Sorters $Sorters -Query $Query -Limit $Limit -Count $Count -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAccessItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-snapshot-access-items Use this API to get a list of identity access items at a specified date, filtered by item type. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-snapshot-access-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -526,19 +556,22 @@ $Type = "role" # String | Access item type. (optional) # Get Identity Access Items Snapshot try { - Get-BetaIdentitySnapshotAccessItems -BetaId $Id -BetaDate $Date + Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshotAccessItems -BetaId $Id -BetaDate $Date -BetaType $Type + # Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotAccessItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-snapshots This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-snapshots) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -578,10 +611,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Lists all the snapshots for the identity try { - Get-BetaIdentitySnapshots -BetaId $Id + Get-BetaIdentitySnapshots -Id $Id # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshots -BetaId $Id -BetaStart $Start -BetaInterval $Interval -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + # Get-BetaIdentitySnapshots -Id $Id -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshots" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md index 18e07dd72..bf92cf200 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md @@ -40,11 +40,14 @@ Method | HTTP request | Description [**Sync-BetaIdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile [**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile + ## create-identity-profile This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -123,16 +126,17 @@ $IdentityProfile = @"{ try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-BetaIdentityProfile -BetaIdentityProfile $Result + New-BetaIdentityProfile -BetaIdentityProfile $Result # Below is a request that includes all optional parameters - # New-BetaIdentityProfile -BetaIdentityProfile $IdentityProfile + # New-BetaIdentityProfile -BetaIdentityProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-identity-profile This deletes an Identity Profile based on ID. @@ -142,6 +146,8 @@ A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -172,16 +178,17 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity # Delete an Identity Profile try { - Remove-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters - # Remove-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + # Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-identity-profiles This deletes multiple Identity Profiles via a list of supplied IDs. @@ -191,6 +198,8 @@ A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -223,19 +232,22 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-BetaIdentityProfiles -BetaRequestBody $Result + Remove-BetaIdentityProfiles -RequestBody $Result # Below is a request that includes all optional parameters - # Remove-BetaIdentityProfiles -BetaRequestBody $RequestBody + # Remove-BetaIdentityProfiles -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-identity-profiles This exports existing identity profiles in the format specified by the sp-config service. +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -274,20 +286,23 @@ $Sorters = "name,-priority" # String | Sort results using the standard syntax de # Export Identity Profiles try { - Export-BetaIdentityProfiles + Export-BetaIdentityProfiles # Below is a request that includes all optional parameters - # Export-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Export-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaIdentityProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-default-identity-attribute-config This returns the default identity attribute config A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-default-identity-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -318,21 +333,24 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity # Default identity attribute config try { - Get-BetaDefaultIdentityAttributeConfig -BetaIdentityProfileId $IdentityProfileId + Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters - # Get-BetaDefaultIdentityAttributeConfig -BetaIdentityProfileId $IdentityProfileId + # Get-BetaDefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultIdentityAttributeConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-profile This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -363,19 +381,22 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity # Gets a single Identity Profile try { - Get-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters - # Get-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + # Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-identity-profiles This imports previously exported identity profiles. +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -468,20 +489,23 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $Result + Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $Result # Below is a request that includes all optional parameters - # Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $IdentityProfileExportedObject + # Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-profiles This returns a list of Identity Profiles based on the specified query parameters. A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -519,21 +543,24 @@ $Sorters = "name,-priority" # String | Sort results using the standard syntax de # Identity Profiles List try { - Get-BetaIdentityProfiles + Get-BetaIdentityProfiles # Below is a request that includes all optional parameters - # Get-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaIdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## show-generate-identity-preview Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. A token with ORG_ADMIN authority is required to call this API to generate an identity preview. +[API Spec](https://developer.sailpoint.com/docs/api/beta/show-generate-identity-preview) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -590,16 +617,17 @@ $IdentityPreviewRequest = @"{ try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $Result + Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $Result # Below is a request that includes all optional parameters - # Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $IdentityPreviewRequest + # Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## sync-identity-profile Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. @@ -608,6 +636,8 @@ This operation will perform the following activities on all identities under the 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/sync-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -638,16 +668,17 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity # Process identities under profile try { - Sync-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters - # Sync-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + # Sync-BetaIdentityProfile -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaIdentityProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-identity-profile This updates the specified Identity Profile. @@ -662,6 +693,8 @@ Some fields of the Schema cannot be updated. These fields are listed below: * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -700,10 +733,10 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result + Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaIdentityProfile" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md index 37227878a..9b777ae06 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md @@ -27,9 +27,12 @@ Method | HTTP request | Description [**Send-BetaLauncher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace Launcher [**Start-BetaLauncher**](#start-launcher) | **POST** `/beta/launchers/{launcherID}/launch` | Launch a Launcher + ## create-launcher Create a Launcher with given information +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-launcher) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -71,19 +74,22 @@ $LauncherRequest = @"{ try { $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest - New-BetaLauncher -BetaLauncherRequest $Result + New-BetaLauncher -BetaLauncherRequest $Result # Below is a request that includes all optional parameters - # New-BetaLauncher -BetaLauncherRequest $LauncherRequest + # New-BetaLauncher -BetaLauncherRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-launcher Delete the given Launcher ID +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-launcher) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -114,19 +120,22 @@ $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launch # Delete Launcher try { - Remove-BetaLauncher -BetaLauncherID $LauncherID + Remove-BetaLauncher -LauncherID $LauncherID # Below is a request that includes all optional parameters - # Remove-BetaLauncher -BetaLauncherID $LauncherID + # Remove-BetaLauncher -LauncherID $LauncherID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-launcher Get details for the given Launcher ID +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launcher) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,19 +166,22 @@ $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launch # Get Launcher by ID try { - Get-BetaLauncher -BetaLauncherID $LauncherID + Get-BetaLauncher -LauncherID $LauncherID # Below is a request that includes all optional parameters - # Get-BetaLauncher -BetaLauncherID $LauncherID + # Get-BetaLauncher -LauncherID $LauncherID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-launchers Return a list of Launchers for the authenticated tenant +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-launchers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -204,19 +216,22 @@ $Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10) # List all Launchers for tenant try { - Get-BetaLaunchers + Get-BetaLaunchers # Below is a request that includes all optional parameters - # Get-BetaLaunchers -BetaFilters $Filters -BetaNext $Next -BetaLimit $Limit + # Get-BetaLaunchers -Filters $Filters -Next $Next -Limit $Limit } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-launcher Replace the given Launcher ID with given payload +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-launcher) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -260,19 +275,22 @@ $LauncherRequest = @"{ try { $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest - Send-BetaLauncher -BetaLauncherID $LauncherID -BetaLauncherRequest $Result + Send-BetaLauncher -LauncherID $LauncherID -BetaLauncherRequest $Result # Below is a request that includes all optional parameters - # Send-BetaLauncher -BetaLauncherID $LauncherID -BetaLauncherRequest $LauncherRequest + # Send-BetaLauncher -LauncherID $LauncherID -BetaLauncherRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-launcher Launch the given Launcher ID +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-launcher) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -303,10 +321,10 @@ $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launch # Launch a Launcher try { - Start-BetaLauncher -BetaLauncherID $LauncherID + Start-BetaLauncher -LauncherID $LauncherID # Below is a request that includes all optional parameters - # Start-BetaLauncher -BetaLauncherID $LauncherID + # Start-BetaLauncher -LauncherID $LauncherID } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md index 718acb456..98990938b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md @@ -56,12 +56,15 @@ Method | HTTP request | Description [**Get-BetaLifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State [**Update-BetaLifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + ## get-lifecycle-states Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. A token with ORG_ADMIN or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-lifecycle-states) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -93,22 +96,25 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle Stat # Get Lifecycle State try { - Get-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId + Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId # Below is a request that includes all optional parameters - # Get-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId + # Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-lifecycle-states Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-lifecycle-states) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -148,10 +154,10 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle Stat try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result + Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md index f026248bc..1bdc2b416 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md @@ -26,9 +26,12 @@ Method | HTTP request | Description [**Set-BetaMFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration [**Test-BetaMFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration + ## delete-mfa-config This API removes the configuration for the specified MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-mfa-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -58,19 +61,22 @@ $Method = "okta-verify" # String | The name of the MFA method. The currently sup # Delete MFA method configuration try { - Remove-BetaMFAConfig -BetaMethod $Method + Remove-BetaMFAConfig -Method $Method # Below is a request that includes all optional parameters - # Remove-BetaMFAConfig -BetaMethod $Method + # Remove-BetaMFAConfig -Method $Method } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMFAConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-mfa-duo-config This API returns the configuration of an Duo MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-duo-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -98,7 +104,7 @@ Code | Description | Data Type # Configuration of Duo MFA method try { - Get-BetaMFADuoConfig + Get-BetaMFADuoConfig # Below is a request that includes all optional parameters # Get-BetaMFADuoConfig @@ -108,9 +114,12 @@ try { } ``` [[Back to top]](#) + ## get-mfa-kba-config This API returns the KBA configuration for MFA. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-kba-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -140,19 +149,22 @@ $AllLanguages = $false # Boolean | Indicator whether the question text should be # Configuration of KBA MFA method try { - Get-BetaMFAKbaConfig + Get-BetaMFAKbaConfig # Below is a request that includes all optional parameters - # Get-BetaMFAKbaConfig -BetaAllLanguages $AllLanguages + # Get-BetaMFAKbaConfig -AllLanguages $AllLanguages } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAKbaConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-mfa-okta-config This API returns the configuration of an Okta MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-okta-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -180,7 +192,7 @@ Code | Description | Data Type # Configuration of Okta MFA method try { - Get-BetaMFAOktaConfig + Get-BetaMFAOktaConfig # Below is a request that includes all optional parameters # Get-BetaMFAOktaConfig @@ -190,9 +202,12 @@ try { } ``` [[Back to top]](#) + ## set-mfa-duo-config This API sets the configuration of an Duo MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfa-duo-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -233,19 +248,22 @@ $MfaDuoConfig = @"{ try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-BetaMFADuoConfig -BetaMfaDuoConfig $Result + Set-BetaMFADuoConfig -BetaMfaDuoConfig $Result # Below is a request that includes all optional parameters - # Set-BetaMFADuoConfig -BetaMfaDuoConfig $MfaDuoConfig + # Set-BetaMFADuoConfig -BetaMfaDuoConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-mfakba-config This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfakba-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -280,19 +298,22 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $Result + Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $KbaAnswerRequestItem + # Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-mfa-okta-config This API sets the configuration of an Okta MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfa-okta-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -329,19 +350,22 @@ $MfaOktaConfig = @"{ try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-BetaMFAOktaConfig -BetaMfaOktaConfig $Result + Set-BetaMFAOktaConfig -BetaMfaOktaConfig $Result # Below is a request that includes all optional parameters - # Set-BetaMFAOktaConfig -BetaMfaOktaConfig $MfaOktaConfig + # Set-BetaMFAOktaConfig -BetaMfaOktaConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-mfa-config This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-mfa-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -371,10 +395,10 @@ $Method = "okta-verify" # String | The name of the MFA method. The currently sup # MFA method's test configuration try { - Test-BetaMFAConfig -BetaMethod $Method + Test-BetaMFAConfig -Method $Method # Below is a request that includes all optional parameters - # Test-BetaMFAConfig -BetaMethod $Method + # Test-BetaMFAConfig -Method $Method } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaMFAConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md index 65f348df1..65ee4464a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md @@ -24,9 +24,12 @@ Method | HTTP request | Description [**Send-BetaOktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method [**Send-BetaTokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method + ## create-send-token This API send token request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-send-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -60,19 +63,22 @@ $SendTokenRequest = @"{ try { $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest - New-BetaSendToken -BetaSendTokenRequest $Result + New-BetaSendToken -BetaSendTokenRequest $Result # Below is a request that includes all optional parameters - # New-BetaSendToken -BetaSendTokenRequest $SendTokenRequest + # New-BetaSendToken -BetaSendTokenRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## ping-verification-status This API poll the VerificationPollRequest for the specified MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/beta/ping-verification-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -107,19 +113,22 @@ $VerificationPollRequest = @"{ try { $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest - Ping-BetaVerificationStatus -BetaMethod $Method -BetaVerificationPollRequest $Result + Ping-BetaVerificationStatus -Method $Method -BetaVerificationPollRequest $Result # Below is a request that includes all optional parameters - # Ping-BetaVerificationStatus -BetaMethod $Method -BetaVerificationPollRequest $VerificationPollRequest + # Ping-BetaVerificationStatus -Method $Method -BetaVerificationPollRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-duo-verify-request This API Authenticates the user via Duo-Web MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-duo-verify-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -153,19 +162,22 @@ $DuoVerificationRequest = @"{ try { $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest - Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $Result + Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $Result # Below is a request that includes all optional parameters - # Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $DuoVerificationRequest + # Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-kba-answers This API Authenticate user in KBA MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-kba-answers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -200,19 +212,22 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $Result + Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $KbaAnswerRequestItem + # Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-okta-verify-request This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller. +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-okta-verify-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -245,19 +260,22 @@ $OktaVerificationRequest = @"{ try { $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest - Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $Result + Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $Result # Below is a request that includes all optional parameters - # Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $OktaVerificationRequest + # Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-token-auth-request This API Authenticate user in Token MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-token-auth-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -292,10 +310,10 @@ $TokenAuthRequest = @"{ try { $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest - Send-BetaTokenAuthRequest -BetaTokenAuthRequest $Result + Send-BetaTokenAuthRequest -BetaTokenAuthRequest $Result # Below is a request that includes all optional parameters - # Send-BetaTokenAuthRequest -BetaTokenAuthRequest $TokenAuthRequest + # Send-BetaTokenAuthRequest -BetaTokenAuthRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md index dd9910a33..0f4097b72 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md @@ -22,9 +22,15 @@ Method | HTTP request | Description [**Get-BetaManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Specified Managed Client Status. [**Update-BetaManagedClientStatus**](#update-managed-client-status) | **POST** `/managed-clients/{id}/status` | Handle status request from client + ## get-managed-client-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Retrieve Managed Client Status by ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-client-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -57,19 +63,25 @@ $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get # Specified Managed Client Status. try { - Get-BetaManagedClientStatus -BetaId $Id -BetaType $Type + Get-BetaManagedClientStatus -Id $Id -Type $Type # Below is a request that includes all optional parameters - # Get-BetaManagedClientStatus -BetaId $Id -BetaType $Type + # Get-BetaManagedClientStatus -Id $Id -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-managed-client-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Update a status detail passed in from the client +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-managed-client-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -128,10 +140,10 @@ $ManagedClientStatus = @"{ try { $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus - Update-BetaManagedClientStatus -BetaId $Id -BetaManagedClientStatus $Result + Update-BetaManagedClientStatus -Id $Id -BetaManagedClientStatus $Result # Below is a request that includes all optional parameters - # Update-BetaManagedClientStatus -BetaId $Id -BetaManagedClientStatus $ManagedClientStatus + # Update-BetaManagedClientStatus -Id $Id -BetaManagedClientStatus $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md index 887f71290..538a654a7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md @@ -24,9 +24,15 @@ Method | HTTP request | Description [**Get-BetaManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Retrieve all Managed Clusters. [**Send-BetaClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster's log configuration + ## get-client-log-configuration +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Get managed cluster's log configuration. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-client-log-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -57,19 +63,25 @@ $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for # Get managed cluster's log configuration try { - Get-BetaClientLogConfiguration -BetaId $Id + Get-BetaClientLogConfiguration -Id $Id # Below is a request that includes all optional parameters - # Get-BetaClientLogConfiguration -BetaId $Id + # Get-BetaClientLogConfiguration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-managed-cluster +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Retrieve a ManagedCluster by ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-cluster) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -100,19 +112,25 @@ $Id = "aClusterId" # String | ID of the ManagedCluster to get # Get a specified ManagedCluster. try { - Get-BetaManagedCluster -BetaId $Id + Get-BetaManagedCluster -Id $Id # Below is a request that includes all optional parameters - # Get-BetaManagedCluster -BetaId $Id + # Get-BetaManagedCluster -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-managed-clusters +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Retrieve all Managed Clusters for the current Org, based on request context. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-managed-clusters) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -148,19 +166,25 @@ $Filters = 'operational eq operation' # String | Filter results using the standa # Retrieve all Managed Clusters. try { - Get-BetaManagedClusters + Get-BetaManagedClusters # Below is a request that includes all optional parameters - # Get-BetaManagedClusters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters + # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-client-log-configuration +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Update managed cluster's log configuration +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-client-log-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -199,10 +223,10 @@ $ClientLogConfiguration = @"{ # Update managed cluster's log configuration try { - Send-BetaClientLogConfiguration -BetaId $Id -BetaClientLogConfiguration $Result + Send-BetaClientLogConfiguration -Id $Id -BetaClientLogConfiguration $Result # Below is a request that includes all optional parameters - # Send-BetaClientLogConfiguration -BetaId $Id -BetaClientLogConfiguration $ClientLogConfiguration + # Send-BetaClientLogConfiguration -Id $Id -BetaClientLogConfiguration $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md index b00e1e14f..9c6718dbd 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md @@ -34,11 +34,14 @@ Method | HTTP request | Description [**Test-BetaSourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source [**Update-BetaMultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update Multi-Host Integration + ## create-multi-host-integration This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-multi-host-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -95,21 +98,24 @@ $MultiHostIntegrationsCreate = @"{ try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate - New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result + New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result # Below is a request that includes all optional parameters - # New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $MultiHostIntegrationsCreate + # New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-sources-within-multi-host This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sources-within-multi-host) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -155,21 +161,24 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Hos try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources - New-BetaSourcesWithinMultiHost -BetaMultihostId $MultihostId -BetaMultiHostIntegrationsCreateSources $Result + New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -BetaMultiHostIntegrationsCreateSources $Result # Below is a request that includes all optional parameters - # New-BetaSourcesWithinMultiHost -BetaMultihostId $MultihostId -BetaMultiHostIntegrationsCreateSources $MultiHostIntegrationsCreateSources + # New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -BetaMultiHostIntegrationsCreateSources $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-multi-host Delete an existing Multi-Host Integration by ID. A token with Org Admin or Multi Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-multi-host) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -200,21 +209,24 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host In # Delete Multi-Host Integration try { - Remove-BetaMultiHost -BetaMultihostId $MultihostId + Remove-BetaMultiHost -MultihostId $MultihostId # Below is a request that includes all optional parameters - # Remove-BetaMultiHost -BetaMultihostId $MultihostId + # Remove-BetaMultiHost -MultihostId $MultihostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMultiHost" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-acct-aggregation-groups This API will return array of account aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-acct-aggregation-groups) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -245,21 +257,24 @@ $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to upd # Get Account Aggregation Groups Within Multi-Host Integration ID try { - Get-BetaAcctAggregationGroups -BetaMultihostId $MultihostId + Get-BetaAcctAggregationGroups -MultihostId $MultihostId # Below is a request that includes all optional parameters - # Get-BetaAcctAggregationGroups -BetaMultihostId $MultihostId + # Get-BetaAcctAggregationGroups -MultihostId $MultihostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAcctAggregationGroups" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-entitlement-aggregation-groups This API will return array of aggregation groups within provided Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-aggregation-groups) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -290,21 +305,24 @@ $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to upd # Get Entitlement Aggregation Groups Within Multi-Host Integration ID try { - Get-BetaEntitlementAggregationGroups -BetaMultiHostId $MultiHostId + Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId # Below is a request that includes all optional parameters - # Get-BetaEntitlementAggregationGroups -BetaMultiHostId $MultiHostId + # Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementAggregationGroups" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-multi-host-integrations Get an existing Multi-Host Integration. A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-integrations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -335,21 +353,24 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Hos # Get Multi-Host Integration By ID try { - Get-BetaMultiHostIntegrations -BetaMultihostId $MultihostId + Get-BetaMultiHostIntegrations -MultihostId $MultihostId # Below is a request that includes all optional parameters - # Get-BetaMultiHostIntegrations -BetaMultihostId $MultihostId + # Get-BetaMultiHostIntegrations -MultihostId $MultihostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-multi-host-integrations-list Get a list of Multi-Host Integrations. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-integrations-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -390,21 +411,24 @@ $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filter # List All Existing Multi-Host Integrations try { - Get-BetaMultiHostIntegrationsList + Get-BetaMultiHostIntegrationsList # Below is a request that includes all optional parameters - # Get-BetaMultiHostIntegrationsList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count -BetaForSubadmin $ForSubadmin + # Get-BetaMultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrationsList" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-multi-host-source-creation-errors Get a list of sources creation errors within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multi-host-source-creation-errors) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -435,21 +459,24 @@ $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Hos # List Multi-Host Source Creation Errors try { - Get-BetaMultiHostSourceCreationErrors -BetaMultiHostId $MultiHostId + Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId # Below is a request that includes all optional parameters - # Get-BetaMultiHostSourceCreationErrors -BetaMultiHostId $MultiHostId + # Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostSourceCreationErrors" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-multihost-integration-types This API endpoint returns the current list of supported Multi-Host Integration types. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-multihost-integration-types) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -478,7 +505,7 @@ Code | Description | Data Type # List Multi-Host Integration Types try { - Get-BetaMultihostIntegrationTypes + Get-BetaMultihostIntegrationTypes # Below is a request that includes all optional parameters # Get-BetaMultihostIntegrationTypes @@ -488,11 +515,14 @@ try { } ``` [[Back to top]](#) + ## get-sources-within-multi-host Get a list of sources within Multi-Host Integration ID. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sources-within-multi-host) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -533,21 +563,24 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List Sources Within Multi-Host Integration try { - Get-BetaSourcesWithinMultiHost -BetaMultihostId $MultihostId + Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId # Below is a request that includes all optional parameters - # Get-BetaSourcesWithinMultiHost -BetaMultihostId $MultihostId -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count + # Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourcesWithinMultiHost" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-connection-multi-host-sources This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-connection-multi-host-sources) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -578,21 +611,24 @@ $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Hos # Test Configuration For Multi-Host Integration try { - Test-BetaConnectionMultiHostSources -BetaMultihostId $MultihostId + Test-BetaConnectionMultiHostSources -MultihostId $MultihostId # Below is a request that includes all optional parameters - # Test-BetaConnectionMultiHostSources -BetaMultihostId $MultihostId + # Test-BetaConnectionMultiHostSources -MultihostId $MultihostId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaConnectionMultiHostSources" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-source-connection-multihost This endpoint performs a more detailed validation of the source's configuration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-source-connection-multihost) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -625,21 +661,24 @@ $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source withi # Test Configuration For Multi-Host Integration's Single Source try { - Test-BetaSourceConnectionMultihost -BetaMultihostId $MultihostId -BetaSourceId $SourceId + Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId # Below is a request that includes all optional parameters - # Test-BetaSourceConnectionMultihost -BetaMultihostId $MultihostId -BetaSourceId $SourceId + # Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnectionMultihost" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-multi-host-sources Update existing sources within Multi-Host Integration. A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-multi-host-sources) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -674,10 +713,10 @@ $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. try { $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner - Update-BetaMultiHostSources -BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result + Update-BetaMultiHostSources -MultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaMultiHostSources -BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $UpdateMultiHostSourcesRequestInner + # Update-BetaMultiHostSources -MultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaMultiHostSources" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md index 7d5ab77c7..5f83db6c2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md @@ -81,9 +81,12 @@ Method | HTTP request | Description [**Deny-BetaNonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request [**Update-BetaNonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record + ## approve-non-employee-request Approves a non-employee approval request and notifies the next approver. +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -118,21 +121,24 @@ $NonEmployeeApprovalDecision = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeApprovalDecision $Result + Approve-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeApprovalDecision $Result # Below is a request that includes all optional parameters - # Approve-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeApprovalDecision $NonEmployeeApprovalDecision + # Approve-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-record This request will create a non-employee record. Request will require the following security scope: 'idn:nesr:create' +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -176,19 +182,22 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $Result + New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $NonEmployeeRequestBody + # New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-request This request will create a non-employee request and notify the approver +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -232,21 +241,24 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $Result + New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $NonEmployeeRequestBody + # New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-source This request will create a non-employee source. Request will require the following security scope: 'idn:nesr:create' +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -302,19 +314,22 @@ $NonEmployeeSourceRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $Result + New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $Result # Below is a request that includes all optional parameters - # New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody + # New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-source-schema-attributes This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source-schema-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -354,19 +369,22 @@ $NonEmployeeSchemaAttributeBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result + New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result # Below is a request that includes all optional parameters - # New-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody + # New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-record This request will delete a non-employee record. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -396,21 +414,24 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID # Delete Non-Employee Record try { - Remove-BetaNonEmployeeRecord -BetaId $Id + Remove-BetaNonEmployeeRecord -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeRecord -BetaId $Id + # Remove-BetaNonEmployeeRecord -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-record-in-bulk This request will delete multiple non-employee records based on the non-employee ids provided. Request will require the following scope: 'idn:nesr:delete' +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-record-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -441,19 +462,22 @@ $DeleteNonEmployeeRecordInBulkRequest = @""@ try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest - Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $Result + Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $Result # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $DeleteNonEmployeeRecordInBulkRequest + # Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-request This request will delete a non-employee request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -484,20 +508,23 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in t # Delete Non-Employee Request try { - Remove-BetaNonEmployeeRequest -BetaId $Id + Remove-BetaNonEmployeeRequest -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeRequest -BetaId $Id + # Remove-BetaNonEmployeeRequest -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-schema-attribute This end-point deletes a specific schema attribute for a non-employee source. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-schema-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -529,19 +556,22 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id # Delete Non-Employee Source's Schema Attribute try { - Remove-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId + Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId + # Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-source This request will delete a non-employee source. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -571,19 +601,22 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id # Delete Non-Employee Source try { - Remove-BetaNonEmployeeSource -BetaSourceId $SourceId + Remove-BetaNonEmployeeSource -SourceId $SourceId # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeSource -BetaSourceId $SourceId + # Remove-BetaNonEmployeeSource -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-source-schema-attributes This end-point deletes all custom schema attributes for a non-employee source. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-non-employee-source-schema-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -613,19 +646,22 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id # Delete all custom schema attributes try { - Remove-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId + Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId + # Remove-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-non-employee-records This requests a CSV download for all non-employees from a provided source. +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-non-employee-records) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -656,21 +692,24 @@ $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) # Exports Non-Employee Records to CSV try { - Export-BetaNonEmployeeRecords -BetaId $Id + Export-BetaNonEmployeeRecords -Id $Id # Below is a request that includes all optional parameters - # Export-BetaNonEmployeeRecords -BetaId $Id + # Export-BetaNonEmployeeRecords -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeRecords" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-non-employee-source-schema-template This requests a download for the Source Schema Template for a provided source. Request will require the following security scope: idn:nesr:read' +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-non-employee-source-schema-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -701,19 +740,22 @@ $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) # Exports Source Schema Template try { - Export-BetaNonEmployeeSourceSchemaTemplate -BetaId $Id + Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id # Below is a request that includes all optional parameters - # Export-BetaNonEmployeeSourceSchemaTemplate -BetaId $Id + # Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeSourceSchemaTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-approval Approves a non-employee approval request and notifies the next approver. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-approval) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -745,19 +787,22 @@ $IncludeDetail = "include-detail=false" # String | The object nonEmployeeRequest # Get a non-employee approval item detail try { - Get-BetaNonEmployeeApproval -BetaId $Id + Get-BetaNonEmployeeApproval -Id $Id # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeApproval -BetaId $Id -BetaIncludeDetail $IncludeDetail + # Get-BetaNonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-approval-summary This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. 2. The current user is an approver, in which case "me" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-approval-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -787,20 +832,23 @@ $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity ( # Get Summary of Non-Employee Approval Requests try { - Get-BetaNonEmployeeApprovalSummary -BetaRequestedFor $RequestedFor + Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeApprovalSummary -BetaRequestedFor $RequestedFor + # Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApprovalSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-bulk-upload-status The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-bulk-upload-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -830,19 +878,22 @@ $Id = "2c918085842e69ae018432d22ccb212f" # String | Source ID (UUID) # Bulk upload status on source try { - Get-BetaNonEmployeeBulkUploadStatus -BetaId $Id + Get-BetaNonEmployeeBulkUploadStatus -Id $Id # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeBulkUploadStatus -BetaId $Id + # Get-BetaNonEmployeeBulkUploadStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeBulkUploadStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-record This gets a non-employee record. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -872,19 +923,22 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID # Get a Non-Employee Record try { - Get-BetaNonEmployeeRecord -BetaId $Id + Get-BetaNonEmployeeRecord -Id $Id # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRecord -BetaId $Id + # Get-BetaNonEmployeeRecord -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-request This gets a non-employee request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -915,19 +969,22 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUI # Get a Non-Employee Request try { - Get-BetaNonEmployeeRequest -BetaId $Id + Get-BetaNonEmployeeRequest -Id $Id # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRequest -BetaId $Id + # Get-BetaNonEmployeeRequest -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-request-summary This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-request-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -957,19 +1014,22 @@ $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity ( # Get Summary of Non-Employee Requests try { - Get-BetaNonEmployeeRequestSummary -BetaRequestedFor $RequestedFor + Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRequestSummary -BetaRequestedFor $RequestedFor + # Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-schema-attribute This API gets a schema attribute by Id for the specified Non-Employee SourceId. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-schema-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1001,19 +1061,22 @@ $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id # Get Schema Attribute Non-Employee Source try { - Get-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId + Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId + # Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-source This gets a non-employee source. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1043,19 +1106,22 @@ $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id # Get a Non-Employee Source try { - Get-BetaNonEmployeeSource -BetaSourceId $SourceId + Get-BetaNonEmployeeSource -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSource -BetaSourceId $SourceId + # Get-BetaNonEmployeeSource -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-source-schema-attributes This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-non-employee-source-schema-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1086,21 +1152,24 @@ $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id # List Schema Attributes Non-Employee Source try { - Get-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId + Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId + # Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-non-employee-records-in-bulk This post will import, or update, Non-Employee records found in the CSV. Request will need the following security scope: 'idn:nesr:create' +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-non-employee-records-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1133,19 +1202,22 @@ $Data = # System.IO.FileInfo | # Imports, or Updates, Non-Employee Records try { - Import-BetaNonEmployeeRecordsInBulk -BetaId $Id -BetaData $Data + Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data # Below is a request that includes all optional parameters - # Import-BetaNonEmployeeRecordsInBulk -BetaId $Id -BetaData $Data + # Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-non-employee-approval This gets a list of non-employee approval requests. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-approval) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1185,19 +1257,22 @@ $Sorters = "created" # String | Sort results using the standard syntax described # Get List of Non-Employee Approval Requests try { - Get-BetaNonEmployeeApproval + Get-BetaNonEmployeeApproval # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeApproval -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaNonEmployeeApproval -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-non-employee-records This gets a list of non-employee records. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-records) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1235,19 +1310,22 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re # List Non-Employee Records try { - Get-BetaNonEmployeeRecords + Get-BetaNonEmployeeRecords # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRecords -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaNonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-non-employee-requests This gets a list of non-employee requests. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-requests) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1287,19 +1365,22 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re # List Non-Employee Requests try { - Get-BetaNonEmployeeRequests -BetaRequestedFor $RequestedFor + Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRequests -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-non-employee-sources This gets a list of non-employee sources. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-sources) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1339,19 +1420,22 @@ $Sorters = "name,created" # String | Sort results using the standard syntax desc # List Non-Employee Sources try { - Get-BetaNonEmployeeSources -BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount + Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSources -BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters + # Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-non-employee-record This request will patch a non-employee record. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1390,20 +1474,23 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeRecord -BetaId $Id -BetaJsonPatchOperation $Result + Update-BetaNonEmployeeRecord -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeRecord -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaNonEmployeeRecord -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-non-employee-schema-attribute This end-point patches a specific schema attribute for a non-employee SourceId. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-schema-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1444,19 +1531,22 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $Result + Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-non-employee-source patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1494,19 +1584,22 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeSource -BetaSourceId $SourceId -BetaJsonPatchOperation $Result + Update-BetaNonEmployeeSource -SourceId $SourceId -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeSource -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaNonEmployeeSource -SourceId $SourceId -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reject-non-employee-request This endpoint will reject an approval item request and notify user. +[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1541,19 +1634,22 @@ $NonEmployeeRejectApprovalDecision = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeRejectApprovalDecision $Result + Deny-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeRejectApprovalDecision $Result # Below is a request that includes all optional parameters - # Deny-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision + # Deny-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeRejectApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-non-employee-record This request will update a non-employee record. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1600,10 +1696,10 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-BetaNonEmployeeRecord -BetaId $Id -BetaNonEmployeeRequestBody $Result + Update-BetaNonEmployeeRecord -Id $Id -BetaNonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeRecord -BetaId $Id -BetaNonEmployeeRequestBody $NonEmployeeRequestBody + # Update-BetaNonEmployeeRecord -Id $Id -BetaNonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md index d0a9b2587..4e79b0af0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md @@ -33,9 +33,12 @@ Method | HTTP request | Description [**Send-BetaMailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain [**Send-BetaTestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification + ## create-domain-dkim Create a domain to be verified via DKIM (DomainKeys Identified Mail) +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-domain-dkim) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -69,21 +72,24 @@ $DomainAddress = @"{ try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress - New-BetaDomainDkim -BetaDomainAddress $Result + New-BetaDomainDkim -BetaDomainAddress $Result # Below is a request that includes all optional parameters - # New-BetaDomainDkim -BetaDomainAddress $DomainAddress + # New-BetaDomainDkim -BetaDomainAddress $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-notification-template This creates a template for your site. You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-notification-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -131,19 +137,22 @@ $TemplateDto = @"{ try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto - New-BetaNotificationTemplate -BetaTemplateDto $Result + New-BetaNotificationTemplate -BetaTemplateDto $Result # Below is a request that includes all optional parameters - # New-BetaNotificationTemplate -BetaTemplateDto $TemplateDto + # New-BetaNotificationTemplate -BetaTemplateDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-verified-from-address Create a new sender email address and initiate verification process. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-verified-from-address) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -179,19 +188,22 @@ $EmailStatusDto = @"{ try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto - New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result + New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result # Below is a request that includes all optional parameters - # New-BetaVerifiedFromAddress -BetaEmailStatusDto $EmailStatusDto + # New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-notification-templates-in-bulk This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-notification-templates-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -227,19 +239,22 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto - Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $Result + Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $Result # Below is a request that includes all optional parameters - # Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $TemplateBulkDeleteDto + # Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-verified-from-address Delete a verified sender email address +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-verified-from-address) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -270,19 +285,22 @@ $Id = "MyId" # String | # Delete Verified From Address try { - Remove-BetaVerifiedFromAddress -BetaId $Id + Remove-BetaVerifiedFromAddress -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaVerifiedFromAddress -BetaId $Id + # Remove-BetaVerifiedFromAddress -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-dkim-attributes Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-dkim-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -310,7 +328,7 @@ Code | Description | Data Type # Get DKIM Attributes try { - Get-BetaDkimAttributes + Get-BetaDkimAttributes # Below is a request that includes all optional parameters # Get-BetaDkimAttributes @@ -320,9 +338,12 @@ try { } ``` [[Back to top]](#) + ## get-mail-from-attributes Retrieve MAIL FROM attributes for a given AWS SES identity. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mail-from-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -352,19 +373,22 @@ $IdentityId = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record # Get MAIL FROM Attributes try { - Get-BetaMailFromAttributes -BetaIdentityId $IdentityId + Get-BetaMailFromAttributes -IdentityId $IdentityId # Below is a request that includes all optional parameters - # Get-BetaMailFromAttributes -BetaIdentityId $IdentityId + # Get-BetaMailFromAttributes -IdentityId $IdentityId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-notification-template This gets a template that you have modified for your site by Id. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-notification-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -394,20 +418,23 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification T # Get Notification Template By Id try { - Get-BetaNotificationTemplate -BetaId $Id + Get-BetaNotificationTemplate -Id $Id # Below is a request that includes all optional parameters - # Get-BetaNotificationTemplate -BetaId $Id + # Get-BetaNotificationTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-notifications-template-context The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-notifications-template-context) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -435,7 +462,7 @@ Code | Description | Data Type # Get Notification Template Context try { - Get-BetaNotificationsTemplateContext + Get-BetaNotificationsTemplateContext # Below is a request that includes all optional parameters # Get-BetaNotificationsTemplateContext @@ -445,9 +472,12 @@ try { } ``` [[Back to top]](#) + ## list-from-addresses Retrieve a list of sender email addresses and their verification statuses +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-from-addresses) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -484,19 +514,22 @@ $Sorters = "email" # String | Sort results using the standard syntax described i # List From Addresses try { - Get-BetaFromAddresses + Get-BetaFromAddresses # Below is a request that includes all optional parameters - # Get-BetaFromAddresses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaFromAddresses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-notification-preferences Returns a list of notification preferences for tenant. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-preferences) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -527,19 +560,22 @@ $Key = "cloud_manual_work_item_summary" # String | The notification key. # List Notification Preferences for tenant. try { - Get-BetaNotificationPreferences -BetaKey $Key + Get-BetaNotificationPreferences -Key $Key # Below is a request that includes all optional parameters - # Get-BetaNotificationPreferences -BetaKey $Key + # Get-BetaNotificationPreferences -Key $Key } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-notification-template-defaults This lists the default templates used for notifications, such as emails from IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-template-defaults) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -573,19 +609,22 @@ $Filters = 'key eq "cloud_manual_work_item_summary"' # String | Filter results u # List Notification Template Defaults try { - Get-BetaNotificationTemplateDefaults + Get-BetaNotificationTemplateDefaults # Below is a request that includes all optional parameters - # Get-BetaNotificationTemplateDefaults -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + # Get-BetaNotificationTemplateDefaults -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-notification-templates This lists the templates that you have modified for your site. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-templates) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -619,19 +658,22 @@ $Filters = 'medium eq "EMAIL"' # String | Filter results using the standard synt # List Notification Templates try { - Get-BetaNotificationTemplates + Get-BetaNotificationTemplates # Below is a request that includes all optional parameters - # Get-BetaNotificationTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + # Get-BetaNotificationTemplates -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-mail-from-attributes Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-mail-from-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -665,19 +707,22 @@ $MailFromAttributesDto = @"{ try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto - Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result + Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result # Below is a request that includes all optional parameters - # Send-BetaMailFromAttributes -BetaMailFromAttributesDto $MailFromAttributesDto + # Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-test-notification Send a Test Notification +[API Spec](https://developer.sailpoint.com/docs/api/beta/send-test-notification) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -713,10 +758,10 @@ $SendTestNotificationRequestDto = @"{ try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto - Send-BetaTestNotification -BetaSendTestNotificationRequestDto $Result + Send-BetaTestNotification -BetaSendTestNotificationRequestDto $Result # Below is a request that includes all optional parameters - # Send-BetaTestNotification -BetaSendTestNotificationRequestDto $SendTestNotificationRequestDto + # Send-BetaTestNotification -BetaSendTestNotificationRequestDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md index 084bd312c..1a99d5a35 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md @@ -26,9 +26,12 @@ Method | HTTP request | Description [**Get-BetaOauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients [**Update-BetaOauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client + ## create-oauth-client This creates an OAuth client. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -75,19 +78,22 @@ $CreateOAuthClientRequest = @"{ try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-BetaOauthClient -BetaCreateOAuthClientRequest $Result + New-BetaOauthClient -BetaCreateOAuthClientRequest $Result # Below is a request that includes all optional parameters - # New-BetaOauthClient -BetaCreateOAuthClientRequest $CreateOAuthClientRequest + # New-BetaOauthClient -BetaCreateOAuthClientRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-oauth-client This deletes an OAuth client. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -118,19 +124,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id # Delete OAuth Client try { - Remove-BetaOauthClient -BetaId $Id + Remove-BetaOauthClient -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaOauthClient -BetaId $Id + # Remove-BetaOauthClient -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaOauthClient" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-oauth-client This gets details of an OAuth client. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -161,19 +170,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id # Get OAuth Client try { - Get-BetaOauthClient -BetaId $Id + Get-BetaOauthClient -Id $Id # Below is a request that includes all optional parameters - # Get-BetaOauthClient -BetaId $Id + # Get-BetaOauthClient -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClient" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-oauth-clients This gets a list of OAuth clients. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-oauth-clients) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -203,21 +215,24 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin # List OAuth Clients try { - Get-BetaOauthClients + Get-BetaOauthClients # Below is a request that includes all optional parameters - # Get-BetaOauthClients -BetaFilters $Filters + # Get-BetaOauthClients -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClients" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-oauth-client This performs a targeted update to the field(s) of an OAuth client. Request will require a security scope of - sp:oauth-client:manage +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -256,10 +271,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaOauthClient -BetaId $Id -BetaJsonPatchOperation $Result + Update-BetaOauthClient -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaOauthClient -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaOauthClient -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOauthClient" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md index 4a32a309d..017692b62 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md @@ -23,9 +23,12 @@ Method | HTTP request | Description [**Get-BetaValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get list of time zones [**Update-BetaOrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch an Org configuration property + ## get-org-config Get org configuration with only external (org admin) accessible properties for the current org. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -54,7 +57,7 @@ Code | Description | Data Type # Get Org configuration settings try { - Get-BetaOrgConfig + Get-BetaOrgConfig # Below is a request that includes all optional parameters # Get-BetaOrgConfig @@ -64,9 +67,12 @@ try { } ``` [[Back to top]](#) + ## get-valid-time-zones Get a list of valid time zones that can be set in org configurations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-valid-time-zones) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -94,7 +100,7 @@ Code | Description | Data Type # Get list of time zones try { - Get-BetaValidTimeZones + Get-BetaValidTimeZones # Below is a request that includes all optional parameters # Get-BetaValidTimeZones @@ -104,9 +110,12 @@ try { } ``` [[Back to top]](#) + ## patch-org-config Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -143,10 +152,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaOrgConfig -BetaJsonPatchOperation $Result + Update-BetaOrgConfig -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaOrgConfig -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaOrgConfig -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOrgConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md index f7231bb41..9ebbaa861 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md @@ -27,11 +27,14 @@ Method | HTTP request | Description [**Get-BetaPasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config [**Send-BetaPasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config + ## create-password-org-config This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-password-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -67,19 +70,22 @@ $PasswordOrgConfig = @"{ try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-BetaPasswordOrgConfig -BetaPasswordOrgConfig $Result + New-BetaPasswordOrgConfig -BetaPasswordOrgConfig $Result # Below is a request that includes all optional parameters - # New-BetaPasswordOrgConfig -BetaPasswordOrgConfig $PasswordOrgConfig + # New-BetaPasswordOrgConfig -BetaPasswordOrgConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordOrgConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-password-org-config This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -107,7 +113,7 @@ Code | Description | Data Type # Get Password Org Config try { - Get-BetaPasswordOrgConfig + Get-BetaPasswordOrgConfig # Below is a request that includes all optional parameters # Get-BetaPasswordOrgConfig @@ -117,11 +123,14 @@ try { } ``` [[Back to top]](#) + ## put-password-org-config This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-password-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,10 +166,10 @@ $PasswordOrgConfig = @"{ try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-BetaPasswordOrgConfig -BetaPasswordOrgConfig $Result + Send-BetaPasswordOrgConfig -BetaPasswordOrgConfig $Result # Below is a request that includes all optional parameters - # Send-BetaPasswordOrgConfig -BetaPasswordOrgConfig $PasswordOrgConfig + # Send-BetaPasswordOrgConfig -BetaPasswordOrgConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordOrgConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordDictionaryApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordDictionaryApi.md index 75c6bed2f..d27ead45c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordDictionaryApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordDictionaryApi.md @@ -67,6 +67,7 @@ Method | HTTP request | Description [**Get-BetaPasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary [**Send-BetaPasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary + ## get-password-dictionary This gets password dictionary for the organization. The password dictionary file can contain lines that are: @@ -98,6 +99,8 @@ qazxsws ``` +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-dictionary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -126,7 +129,7 @@ Code | Description | Data Type # Get Password Dictionary try { - Get-BetaPasswordDictionary + Get-BetaPasswordDictionary # Below is a request that includes all optional parameters # Get-BetaPasswordDictionary @@ -136,6 +139,7 @@ try { } ``` [[Back to top]](#) + ## put-password-dictionary This updates password dictionary for the organization. The password dictionary file can contain lines that are: @@ -167,6 +171,8 @@ qazxsws ``` +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-password-dictionary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -198,10 +204,10 @@ $File = # System.IO.FileInfo | (optional) # Update Password Dictionary try { - Send-BetaPasswordDictionary + Send-BetaPasswordDictionary # Below is a request that includes all optional parameters - # Send-BetaPasswordDictionary -BetaFile $File + # Send-BetaPasswordDictionary -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordDictionary" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md index a615aaf27..a748721d9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md @@ -46,9 +46,12 @@ Method | HTTP request | Description [**Search-BetaPasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info [**Set-BetaIdentityPassword**](#set-identity-password) | **POST** `/set-password` | Set Identity's Password + ## create-digit-token This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-digit-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -83,19 +86,22 @@ $PasswordDigitTokenReset = @"{ try { $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset - New-BetaDigitToken -BetaPasswordDigitTokenReset $Result + New-BetaDigitToken -BetaPasswordDigitTokenReset $Result # Below is a request that includes all optional parameters - # New-BetaDigitToken -BetaPasswordDigitTokenReset $PasswordDigitTokenReset + # New-BetaDigitToken -BetaPasswordDigitTokenReset $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-password-change-status This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-password-change-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -125,16 +131,17 @@ $Id = "MyId" # String | # Get Password Change Request Status try { - Get-BetaIdentityPasswordChangeStatus -BetaId $Id + Get-BetaIdentityPasswordChangeStatus -Id $Id # Below is a request that includes all optional parameters - # Get-BetaIdentityPasswordChangeStatus -BetaId $Id + # Get-BetaIdentityPasswordChangeStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## query-password-info This API is used to query password related information. @@ -146,6 +153,8 @@ grant type will **NOT** work on this endpoint, and a `403 Forbidden` response will be returned. +[API Spec](https://developer.sailpoint.com/docs/api/beta/query-password-info) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -179,16 +188,17 @@ $PasswordInfoQueryDTO = @"{ try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $Result + Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $Result # Below is a request that includes all optional parameters - # Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $PasswordInfoQueryDTO + # Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-identity-password This API is used to set a password for an identity. @@ -235,6 +245,8 @@ In this example, `toEncrypt` refers to the plain text password you are setting a You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-identity-password) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -271,10 +283,10 @@ $PasswordChangeRequest = @"{ try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-BetaIdentityPassword -BetaPasswordChangeRequest $Result + Set-BetaIdentityPassword -BetaPasswordChangeRequest $Result # Below is a request that includes all optional parameters - # Set-BetaIdentityPassword -BetaPasswordChangeRequest $PasswordChangeRequest + # Set-BetaIdentityPassword -BetaPasswordChangeRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md index 8e888be6d..b20a0fbe5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md @@ -32,9 +32,12 @@ Method | HTTP request | Description [**Get-BetaPasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies [**Set-BetaPasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID + ## create-password-policy This API creates the specified password policy. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-password-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -98,19 +101,22 @@ $PasswordPolicyV3Dto = @"{ try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $Result + New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters - # New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto + # New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-password-policy This API deletes the specified password policy. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-password-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -141,19 +147,22 @@ $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to # Delete Password Policy by ID try { - Remove-BetaPasswordPolicy -BetaId $Id + Remove-BetaPasswordPolicy -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaPasswordPolicy -BetaId $Id + # Remove-BetaPasswordPolicy -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-password-policy-by-id This API returns the password policy for the specified ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-policy-by-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -184,20 +193,23 @@ $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to # Get Password Policy by ID try { - Get-BetaPasswordPolicyById -BetaId $Id + Get-BetaPasswordPolicyById -Id $Id # Below is a request that includes all optional parameters - # Get-BetaPasswordPolicyById -BetaId $Id + # Get-BetaPasswordPolicyById -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-password-policies This gets list of all Password Policies. Requires role of ORG_ADMIN +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-password-policies) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -231,19 +243,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List Password Policies try { - Get-BetaPasswordPolicies + Get-BetaPasswordPolicies # Below is a request that includes all optional parameters - # Get-BetaPasswordPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + # Get-BetaPasswordPolicies -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-password-policy This API updates the specified password policy. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-password-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -309,10 +324,10 @@ $PasswordPolicyV3Dto = @"{ try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-BetaPasswordPolicy -BetaId $Id -BetaPasswordPolicyV3Dto $Result + Set-BetaPasswordPolicy -Id $Id -BetaPasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters - # Set-BetaPasswordPolicy -BetaId $Id -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto + # Set-BetaPasswordPolicy -Id $Id -BetaPasswordPolicyV3Dto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md index a2a44a5fc..46dd95e53 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md @@ -55,9 +55,12 @@ Method | HTTP request | Description [**Get-BetaPasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List [**Update-BetaPasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID + ## create-password-sync-group This API creates a password sync group based on the specifications provided. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -95,19 +98,22 @@ $PasswordSyncGroup = @"{ try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $Result + New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $Result # Below is a request that includes all optional parameters - # New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $PasswordSyncGroup + # New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-password-sync-group This API deletes the specified password sync group. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -137,19 +143,22 @@ $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync # Delete Password Sync Group by ID try { - Remove-BetaPasswordSyncGroup -BetaId $Id + Remove-BetaPasswordSyncGroup -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaPasswordSyncGroup -BetaId $Id + # Remove-BetaPasswordSyncGroup -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-password-sync-group This API returns the sync group for the specified ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -180,19 +189,22 @@ $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync # Get Password Sync Group by ID try { - Get-BetaPasswordSyncGroup -BetaId $Id + Get-BetaPasswordSyncGroup -Id $Id # Below is a request that includes all optional parameters - # Get-BetaPasswordSyncGroup -BetaId $Id + # Get-BetaPasswordSyncGroup -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-password-sync-groups This API returns a list of password sync groups. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-password-sync-groups) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -226,19 +238,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Get Password Sync Group List try { - Get-BetaPasswordSyncGroups + Get-BetaPasswordSyncGroups # Below is a request that includes all optional parameters - # Get-BetaPasswordSyncGroups -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + # Get-BetaPasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-password-sync-group This API updates the specified password sync group. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -279,10 +294,10 @@ $PasswordSyncGroup = @"{ try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-BetaPasswordSyncGroup -BetaId $Id -BetaPasswordSyncGroup $Result + Update-BetaPasswordSyncGroup -Id $Id -BetaPasswordSyncGroup $Result # Below is a request that includes all optional parameters - # Update-BetaPasswordSyncGroup -BetaId $Id -BetaPasswordSyncGroup $PasswordSyncGroup + # Update-BetaPasswordSyncGroup -Id $Id -BetaPasswordSyncGroup $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md index 9026c0b64..518c159b9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md @@ -33,9 +33,12 @@ Method | HTTP request | Description [**Get-BetaPersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens [**Update-BetaPersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token + ## create-personal-access-token This creates a personal access token. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-personal-access-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -70,19 +73,22 @@ $CreatePersonalAccessTokenRequest = @"{ try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $Result + New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $Result # Below is a request that includes all optional parameters - # New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest + # New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-personal-access-token This deletes a personal access token. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-personal-access-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -113,19 +119,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id # Delete Personal Access Token try { - Remove-BetaPersonalAccessToken -BetaId $Id + Remove-BetaPersonalAccessToken -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaPersonalAccessToken -BetaId $Id + # Remove-BetaPersonalAccessToken -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPersonalAccessToken" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-personal-access-tokens This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-personal-access-tokens) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,19 +166,22 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin # List Personal Access Tokens try { - Get-BetaPersonalAccessTokens + Get-BetaPersonalAccessTokens # Below is a request that includes all optional parameters - # Get-BetaPersonalAccessTokens -BetaOwnerId $OwnerId -BetaFilters $Filters + # Get-BetaPersonalAccessTokens -OwnerId $OwnerId -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPersonalAccessTokens" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-personal-access-token This performs a targeted update to the field(s) of a Personal Access Token. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-personal-access-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -208,10 +220,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaPersonalAccessToken -BetaId $Id -BetaJsonPatchOperation $Result + Update-BetaPersonalAccessToken -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaPersonalAccessToken -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaPersonalAccessToken -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPersonalAccessToken" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md index 140d11edd..b16b1969b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md @@ -30,9 +30,12 @@ Method | HTTP request | Description [**Get-BetaPublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get Public Identity Config [**Update-BetaPublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update Public Identity Config + ## get-public-identity-config This gets details of public identity config. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-public-identity-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -60,7 +63,7 @@ Code | Description | Data Type # Get Public Identity Config try { - Get-BetaPublicIdentityConfig + Get-BetaPublicIdentityConfig # Below is a request that includes all optional parameters # Get-BetaPublicIdentityConfig @@ -70,9 +73,12 @@ try { } ``` [[Back to top]](#) + ## update-public-identity-config This updates the details of public identity config. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-public-identity-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -117,10 +123,10 @@ $PublicIdentityConfig = @"{ try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $Result + Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $Result # Below is a request that includes all optional parameters - # Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $PublicIdentityConfig + # Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRequestableObjectsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRequestableObjectsApi.md index 13501dd7f..b88599a6c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRequestableObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRequestableObjectsApi.md @@ -22,10 +22,13 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-BetaRequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List + ## list-requestable-objects This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. Any authenticated token can call this endpoint to see their requestable access items. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-requestable-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -75,10 +78,10 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # Requestable Objects List try { - Get-BetaRequestableObjects + Get-BetaRequestableObjects # Below is a request that includes all optional parameters - # Get-BetaRequestableObjects -BetaIdentityId $IdentityId -BetaTypes $Types -BetaTerm $Term -BetaStatuses $Statuses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaRequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRequestableObjects" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRoleInsightsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRoleInsightsApi.md index 5a3c2dd1b..036daf334 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRoleInsightsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRoleInsightsApi.md @@ -27,9 +27,15 @@ Method | HTTP request | Description [**Get-BetaRoleInsightsRequests**](#get-role-insights-requests) | **GET** `/role-insights/requests/{id}` | Returns metadata from prior request. [**Get-BetaRoleInsightsSummary**](#get-role-insights-summary) | **GET** `/role-insights/summary` | Get role insights summary information + ## create-role-insight-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-role-insight-requests) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -57,7 +63,7 @@ Code | Description | Data Type # Generate insights for roles try { - New-BetaRoleInsightRequests + New-BetaRoleInsightRequests # Below is a request that includes all optional parameters # New-BetaRoleInsightRequests @@ -67,9 +73,12 @@ try { } ``` [[Back to top]](#) + ## download-role-insights-entitlements-changes This endpoint returns the entitlement insights for a role. +[API Spec](https://developer.sailpoint.com/docs/api/beta/download-role-insights-entitlements-changes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -102,19 +111,22 @@ $Filters = 'name sw "r"' # String | Filter results using the standard syntax des # Download entitlement insights for a role try { - Invoke-BetaDownloadRoleInsightsEntitlementsChanges -BetaInsightId $InsightId + Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId # Below is a request that includes all optional parameters - # Invoke-BetaDownloadRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters + # Invoke-BetaDownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-entitlement-changes-identities Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-entitlement-changes-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,19 +169,22 @@ $Filters = 'name sw "Jan"' # String | Filter results using the standard syntax d # Get identities for a suggested entitlement (for a role) try { - Get-BetaEntitlementChangesIdentities -BetaInsightId $InsightId -BetaEntitlementId $EntitlementId + Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId # Below is a request that includes all optional parameters - # Get-BetaEntitlementChangesIdentities -BetaInsightId $InsightId -BetaEntitlementId $EntitlementId -BetaHasEntitlement $HasEntitlement -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaEntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChangesIdentities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insight This endpoint gets role insights information for a role. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insight) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -198,19 +213,22 @@ $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight # Get a single role insight try { - Get-BetaRoleInsight -BetaInsightId $InsightId + Get-BetaRoleInsight -InsightId $InsightId # Below is a request that includes all optional parameters - # Get-BetaRoleInsight -BetaInsightId $InsightId + # Get-BetaRoleInsight -InsightId $InsightId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsight" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insights This method returns detailed role insights for each role. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -247,19 +265,22 @@ $Filters = 'name sw "John"' # String | Filter results using the standard syntax # Get role insights try { - Get-BetaRoleInsights + Get-BetaRoleInsights # Below is a request that includes all optional parameters - # Get-BetaRoleInsights -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaRoleInsights -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsights" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insights-current-entitlements This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-current-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -290,19 +311,22 @@ $Filters = 'name sw "r"' # String | Filter results using the standard syntax des # Get current entitlement for a role try { - Get-BetaRoleInsightsCurrentEntitlements -BetaInsightId $InsightId + Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId # Below is a request that includes all optional parameters - # Get-BetaRoleInsightsCurrentEntitlements -BetaInsightId $InsightId -BetaFilters $Filters + # Get-BetaRoleInsightsCurrentEntitlements -InsightId $InsightId -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsCurrentEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insights-entitlements-changes This endpoint returns entitlement insights for a role. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-entitlements-changes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -335,19 +359,25 @@ $Filters = 'name sw "Admin"' # String | Filter results using the standard syntax # Get entitlement insights for a role try { - Get-BetaRoleInsightsEntitlementsChanges -BetaInsightId $InsightId + Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId # Below is a request that includes all optional parameters - # Get-BetaRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters + # Get-BetaRoleInsightsEntitlementsChanges -InsightId $InsightId -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insights-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This endpoint returns details of a prior role insights request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-requests) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -377,19 +407,22 @@ $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights reques # Returns metadata from prior request. try { - Get-BetaRoleInsightsRequests -BetaId $Id + Get-BetaRoleInsightsRequests -Id $Id # Below is a request that includes all optional parameters - # Get-BetaRoleInsightsRequests -BetaId $Id + # Get-BetaRoleInsightsRequests -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsRequests" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insights-summary This method returns high level summary information for role insights for a customer. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-insights-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -416,7 +449,7 @@ Code | Description | Data Type # Get role insights summary information try { - Get-BetaRoleInsightsSummary + Get-BetaRoleInsightsSummary # Below is a request that includes all optional parameters # Get-BetaRoleInsightsSummary diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md index f65118f7f..6610556c2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md @@ -63,6 +63,7 @@ Method | HTTP request | Description [**Get-BetaRoles**](#list-roles) | **GET** `/roles` | List Roles [**Update-BetaRole**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role + ## create-role This API creates a role. @@ -72,6 +73,8 @@ In addition, a ROLE_SUBADMIN may not create a role including an access profile i The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -259,22 +262,25 @@ $Role = @"{ try { $Result = ConvertFrom-JsonToRole -Json $Role - New-BetaRole -BetaRole $Result + New-BetaRole -BetaRole $Result # Below is a request that includes all optional parameters - # New-BetaRole -BetaRole $Role + # New-BetaRole -BetaRole $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-bulk-roles This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-bulk-roles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -307,21 +313,24 @@ $RoleBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $Result + Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $RoleBulkDeleteRequest + # Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-role This API deletes a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -351,20 +360,23 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role # Delete a Role try { - Remove-BetaRole -BetaId $Id + Remove-BetaRole -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaRole -BetaId $Id + # Remove-BetaRole -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role This API returns a Role by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -394,19 +406,22 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role # Get a Role try { - Get-BetaRole -BetaId $Id + Get-BetaRole -Id $Id # Below is a request that includes all optional parameters - # Get-BetaRole -BetaId $Id + # Get-BetaRole -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-assigned-identities +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assigned-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -446,21 +461,24 @@ $Sorters = "aliasName,name" # String | Sort results using the standard syntax de # Identities assigned a Role try { - Get-BetaRoleAssignedIdentities -BetaId $Id + Get-BetaRoleAssignedIdentities -Id $Id # Below is a request that includes all optional parameters - # Get-BetaRoleAssignedIdentities -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaRoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignedIdentities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-entitlements This API lists the Entitlements associated with a given role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -500,21 +518,24 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List role's Entitlements try { - Get-BetaRoleEntitlements -BetaId $Id + Get-BetaRoleEntitlements -Id $Id # Below is a request that includes all optional parameters - # Get-BetaRoleEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaRoleEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-roles This API returns a list of Roles. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-roles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -558,16 +579,17 @@ $IncludeUnsegmented = $false # Boolean | Whether or not the response list should # List Roles try { - Get-BetaRoles + Get-BetaRoles # Below is a request that includes all optional parameters - # Get-BetaRoles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented + # Get-BetaRoles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-role This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. @@ -591,6 +613,8 @@ The maximum supported length for the description field is 2000 characters. Longe When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -628,10 +652,10 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaRole -BetaId $Id -BetaJsonPatchOperation $Result + Update-BetaRole -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaRole -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaRole -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md index 64071ae2f..f1a30a033 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md @@ -32,9 +32,12 @@ Method | HTTP request | Description [**Update-BetaSIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute. [**Send-BetaSIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration + ## create-sim-integration Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sim-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -83,19 +86,22 @@ $SimIntegrationDetails = @"{ try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-BetaSIMIntegration -BetaSimIntegrationDetails $Result + New-BetaSIMIntegration -BetaSimIntegrationDetails $Result # Below is a request that includes all optional parameters - # New-BetaSIMIntegration -BetaSimIntegrationDetails $SimIntegrationDetails + # New-BetaSIMIntegration -BetaSimIntegrationDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-sim-integration Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sim-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -126,19 +132,22 @@ $Id = "12345" # String | The id of the integration to delete. # Delete a SIM integration try { - Remove-BetaSIMIntegration -BetaId $Id + Remove-BetaSIMIntegration -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaSIMIntegration -BetaId $Id + # Remove-BetaSIMIntegration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sim-integration Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -169,19 +178,22 @@ $Id = "12345" # String | The id of the integration. # Get a SIM integration details. try { - Get-BetaSIMIntegration -BetaId $Id + Get-BetaSIMIntegration -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSIMIntegration -BetaId $Id + # Get-BetaSIMIntegration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sim-integrations List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sim-integrations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -210,7 +222,7 @@ Code | Description | Data Type # List the existing SIM integrations. try { - Get-BetaSIMIntegrations + Get-BetaSIMIntegrations # Below is a request that includes all optional parameters # Get-BetaSIMIntegrations @@ -220,9 +232,12 @@ try { } ``` [[Back to top]](#) + ## patch-before-provisioning-rule Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-before-provisioning-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -256,19 +271,22 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\" try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-BetaBeforeProvisioningRule -BetaId $Id -BetaJsonPatch $Result + Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result # Below is a request that includes all optional parameters - # Update-BetaBeforeProvisioningRule -BetaId $Id -BetaJsonPatch $JsonPatch + # Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-sim-attributes Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sim-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -302,19 +320,22 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\" try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-BetaSIMAttributes -BetaId $Id -BetaJsonPatch $Result + Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result # Below is a request that includes all optional parameters - # Update-BetaSIMAttributes -BetaId $Id -BetaJsonPatch $JsonPatch + # Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-sim-integration Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-sim-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -365,10 +386,10 @@ $SimIntegrationDetails = @"{ try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-BetaSIMIntegration -BetaId $Id -BetaSimIntegrationDetails $Result + Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Send-BetaSIMIntegration -BetaId $Id -BetaSimIntegrationDetails $SimIntegrationDetails + # Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md index 7c84eeda7..c85ae9a53 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md @@ -60,10 +60,16 @@ Method | HTTP request | Description [**Start-BetaSodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org [**Start-BetaSodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + ## create-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -149,20 +155,26 @@ $SodPolicy = @"{ try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-BetaSodPolicy -BetaSodPolicy $Result + New-BetaSodPolicy -BetaSodPolicy $Result # Below is a request that includes all optional parameters - # New-BetaSodPolicy -BetaSodPolicy $SodPolicy + # New-BetaSodPolicy -BetaSodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This deletes a specified SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -195,20 +207,26 @@ $Logical = $true # Boolean | Indicates whether this is a soft delete (logical tr # Delete SOD policy by ID try { - Remove-BetaSodPolicy -BetaId $Id + Remove-BetaSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaSodPolicy -BetaId $Id -BetaLogical $Logical + # Remove-BetaSodPolicy -Id $Id -Logical $Logical } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-sod-policy-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This deletes schedule for a specified SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-sod-policy-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -239,20 +257,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the # Delete SOD policy schedule try { - Remove-BetaSodPolicySchedule -BetaId $Id + Remove-BetaSodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaSodPolicySchedule -BetaId $Id + # Remove-BetaSodPolicySchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-custom-violation-report +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This allows to download a specified named violation report for a given report reference. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-custom-violation-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -285,20 +309,26 @@ $FileName = "custom-name" # String | Custom Name for the file. # Download custom violation report try { - Get-BetaCustomViolationReport -BetaReportResultId $ReportResultId -BetaFileName $FileName + Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName # Below is a request that includes all optional parameters - # Get-BetaCustomViolationReport -BetaReportResultId $ReportResultId -BetaFileName $FileName + # Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-default-violation-report +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This allows to download a violation report for a given report reference. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-default-violation-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -329,20 +359,26 @@ $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the re # Download violation report try { - Get-BetaDefaultViolationReport -BetaReportResultId $ReportResultId + Get-BetaDefaultViolationReport -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Get-BetaDefaultViolationReport -BetaReportResultId $ReportResultId + # Get-BetaDefaultViolationReport -ReportResultId $ReportResultId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sod-all-report-run-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This endpoint gets the status for a violation report for all policy run. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-all-report-run-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -370,7 +406,7 @@ Code | Description | Data Type # Get multi-report run task status try { - Get-BetaSodAllReportRunStatus + Get-BetaSodAllReportRunStatus # Below is a request that includes all optional parameters # Get-BetaSodAllReportRunStatus @@ -380,10 +416,16 @@ try { } ``` [[Back to top]](#) + ## get-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This gets specified SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -414,20 +456,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen # Get SOD policy by ID try { - Get-BetaSodPolicy -BetaId $Id + Get-BetaSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSodPolicy -BetaId $Id + # Get-BetaSodPolicy -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sod-policy-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This endpoint gets a specified SOD policy's schedule. Requires the role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-policy-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -457,20 +505,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen # Get SOD policy schedule try { - Get-BetaSodPolicySchedule -BetaId $Id + Get-BetaSodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSodPolicySchedule -BetaId $Id + # Get-BetaSodPolicySchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sod-violation-report-run-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-violation-report-run-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -501,20 +555,26 @@ $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of th # Get violation report run status try { - Get-BetaSodViolationReportRunStatus -BetaReportResultId $ReportResultId + Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Get-BetaSodViolationReportRunStatus -BetaReportResultId $ReportResultId + # Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sod-violation-report-status +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This gets the status for a violation report run task that has already been invoked. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sod-violation-report-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -545,20 +605,26 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen # Get SOD violation report status try { - Get-BetaSodViolationReportStatus -BetaId $Id + Get-BetaSodViolationReportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSodViolationReportStatus -BetaId $Id + # Get-BetaSodViolationReportStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-sod-policies +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This gets list of all SOD policies. Requires role of ORG_ADMIN +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-sod-policies) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -596,21 +662,27 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described # List SOD policies try { - Get-BetaSodPolicies + Get-BetaSodPolicies # Below is a request that includes all optional parameters - # Get-BetaSodPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaSodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -646,20 +718,26 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update ope try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSodPolicy -BetaId $Id -BetaRequestBody $Result + Update-BetaSodPolicy -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Update-BetaSodPolicy -BetaId $Id -BetaRequestBody $RequestBody + # Update-BetaSodPolicy -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-policy-schedule +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This updates schedule for a specified SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-policy-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -777,20 +855,26 @@ $SodPolicySchedule = @"{ try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-BetaPolicySchedule -BetaId $Id -BetaSodPolicySchedule $Result + Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result # Below is a request that includes all optional parameters - # Send-BetaPolicySchedule -BetaId $Id -BetaSodPolicySchedule $SodPolicySchedule + # Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This updates a specified SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -879,20 +963,26 @@ $SodPolicy = @"{ try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-BetaSodPolicy -BetaId $Id -BetaSodPolicy $Result + Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result # Below is a request that includes all optional parameters - # Send-BetaSodPolicy -BetaId $Id -BetaSodPolicy $SodPolicy + # Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-sod-all-policies-for-org +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-sod-all-policies-for-org) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -924,20 +1014,26 @@ $MultiPolicyRequest = @"{ # Runs all policies for org try { - Start-BetaSodAllPoliciesForOrg + Start-BetaSodAllPoliciesForOrg # Below is a request that includes all optional parameters - # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $MultiPolicyRequest + # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-sod-policy +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -968,10 +1064,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. # Runs SOD policy violation report try { - Start-BetaSodPolicy -BetaId $Id + Start-BetaSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Start-BetaSodPolicy -BetaId $Id + # Start-BetaSodPolicy -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md index 2a0e464e4..bdcc9f0b0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md @@ -37,11 +37,17 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Start-BetaPredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. + ## start-predict-sod-violations +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. A token with ORG_ADMIN or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-predict-sod-violations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -84,10 +90,10 @@ $IdentityWithNewAccess = @"{ try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result + Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $IdentityWithNewAccess + # Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md index b92b2a4e7..3642036b3 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md @@ -25,10 +25,13 @@ Method | HTTP request | Description [**Import-BetaSpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job [**Get-BetaSpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details + ## export-sp-config This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). +[API Spec](https://developer.sailpoint.com/docs/api/beta/export-sp-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -62,21 +65,24 @@ $ExportPayload = @"{ try { $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-BetaSpConfig -BetaExportPayload $Result + Export-BetaSpConfig -BetaExportPayload $Result # Below is a request that includes all optional parameters - # Export-BetaSpConfig -BetaExportPayload $ExportPayload + # Export-BetaSpConfig -BetaExportPayload $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sp-config-export This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sp-config-export) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -107,21 +113,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job who # Download export job result. try { - Get-BetaSpConfigExport -BetaId $Id + Get-BetaSpConfigExport -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSpConfigExport -BetaId $Id + # Get-BetaSpConfigExport -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sp-config-export-status This gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sp-config-export-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -152,21 +161,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job who # Get export job status try { - Get-BetaSpConfigExportStatus -BetaId $Id + Get-BetaSpConfigExportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSpConfigExportStatus -BetaId $Id + # Get-BetaSpConfigExportStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sp-config-import This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sp-config-import) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -197,20 +209,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job who # Download import job result try { - Get-BetaSpConfigImport -BetaId $Id + Get-BetaSpConfigImport -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSpConfigImport -BetaId $Id + # Get-BetaSpConfigImport -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sp-config-import-status This gets the status of the import job identified by the `id` parameter. 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/beta/get-sp-config-import-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -241,16 +256,17 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job who # Get import job status try { - Get-BetaSpConfigImportStatus -BetaId $Id + Get-BetaSpConfigImportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSpConfigImportStatus -BetaId $Id + # Get-BetaSpConfigImportStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" Write-Host $_.ErrorDetails } ``` [[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. @@ -264,6 +280,8 @@ You cannot currently import from the Non-Employee Lifecycle Management (NELM) so 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/beta/import-sp-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -298,19 +316,22 @@ $Options = @""@ # Initiates configuration objects import job try { - Import-BetaSpConfig -BetaData $Data + Import-BetaSpConfig -Data $Data # Below is a request that includes all optional parameters - # Import-BetaSpConfig -BetaData $Data -BetaPreview $Preview -BetaOptions $Options + # Import-BetaSpConfig -Data $Data -Preview $Preview -BetaOptions $Options } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-sp-config-objects This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-sp-config-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -339,7 +360,7 @@ Code | Description | Data Type # Get config object details try { - Get-BetaSpConfigObjects + Get-BetaSpConfigObjects # Below is a request that includes all optional parameters # Get-BetaSpConfigObjects diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md index 4240be12c..2c90a0185 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md @@ -41,10 +41,13 @@ Method | HTTP request | Description [**Get-BetaSingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute [**Update-BetaSearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + ## create-search-attribute-config Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -83,19 +86,22 @@ $SearchAttributeConfig = @"{ try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result + New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result # Below is a request that includes all optional parameters - # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $SearchAttributeConfig + # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-search-attribute-config Delete an extended attribute configuration by name. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -125,20 +131,23 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf # Delete Extended Search Attribute try { - Remove-BetaSearchAttributeConfig -BetaName $Name + Remove-BetaSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Remove-BetaSearchAttributeConfig -BetaName $Name + # Remove-BetaSearchAttributeConfig -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-search-attribute-config Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC). A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -165,7 +174,7 @@ Code | Description | Data Type # List Extended Search Attributes try { - Get-BetaSearchAttributeConfig + Get-BetaSearchAttributeConfig # Below is a request that includes all optional parameters # Get-BetaSearchAttributeConfig @@ -175,9 +184,12 @@ try { } ``` [[Back to top]](#) + ## get-single-search-attribute-config Get an extended attribute configuration by name. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-single-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -208,21 +220,24 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf # Get Extended Search Attribute try { - Get-BetaSingleSearchAttributeConfig -BetaName $Name + Get-BetaSingleSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Get-BetaSingleSearchAttributeConfig -BetaName $Name + # Get-BetaSingleSearchAttributeConfig -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-search-attribute-config Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -261,10 +276,10 @@ $Name = "promotedMailAttribute" # String | Name of the extended search attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $Result + Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md index 179b54644..f6a415b29 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md @@ -40,11 +40,14 @@ Method | HTTP request | Description [**Get-BetaSegments**](#list-segments) | **GET** `/segments` | List Segments [**Update-BetaSegment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment + ## create-segment This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -98,21 +101,24 @@ $Segment = @"{ try { $Result = ConvertFrom-JsonToSegment -Json $Segment - New-BetaSegment -BetaSegment $Result + New-BetaSegment -BetaSegment $Result # Below is a request that includes all optional parameters - # New-BetaSegment -BetaSegment $Segment + # New-BetaSegment -BetaSegment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-segment This API deletes the segment specified by the given ID. >**Note:** Segment deletion may take some time to go into effect. A token with ORG_ADMIN or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -143,20 +149,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. # Delete Segment by ID try { - Remove-BetaSegment -BetaId $Id + Remove-BetaSegment -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaSegment -BetaId $Id + # Remove-BetaSegment -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-segment This API returns the segment specified by the given ID. A token with ORG_ADMIN or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -187,20 +196,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. # Get Segment by ID try { - Get-BetaSegment -BetaId $Id + Get-BetaSegment -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSegment -BetaId $Id + # Get-BetaSegment -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-segments This API returns a list of all segments. A token with ORG_ADMIN or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-segments) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -234,21 +246,24 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List Segments try { - Get-BetaSegments + Get-BetaSegments # Below is a request that includes all optional parameters - # Get-BetaSegments -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-segment Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. A token with ORG_ADMIN or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -284,10 +299,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSegment -BetaId $Id -BetaRequestBody $Result + Update-BetaSegment -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Update-BetaSegment -BetaId $Id -BetaRequestBody $RequestBody + # Update-BetaSegment -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md index 35a3c1455..86a4ab831 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md @@ -52,9 +52,12 @@ Method | HTTP request | Description [**Send-BetaServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration [**Update-BetaStatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + ## create-service-desk-integration Create a new Service Desk integration. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -116,19 +119,22 @@ $ServiceDeskIntegrationDto = @"{ try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result + New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto + # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-service-desk-integration Delete an existing Service Desk integration by ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -159,19 +165,22 @@ $Id = "anId" # String | ID of Service Desk integration to delete # Delete a Service Desk integration try { - Remove-BetaServiceDeskIntegration -BetaId $Id + Remove-BetaServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaServiceDeskIntegration -BetaId $Id + # Remove-BetaServiceDeskIntegration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-service-desk-integration Get an existing Service Desk integration by ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -202,19 +211,22 @@ $Id = "anId" # String | ID of the Service Desk integration to get # Get a Service Desk integration try { - Get-BetaServiceDeskIntegration -BetaId $Id + Get-BetaServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegration -BetaId $Id + # Get-BetaServiceDeskIntegration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-service-desk-integration-list Get a list of Service Desk integration objects. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -253,19 +265,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List existing Service Desk integrations try { - Get-BetaServiceDeskIntegrationList + Get-BetaServiceDeskIntegrationList # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count + # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-service-desk-integration-template This API endpoint returns an existing Service Desk integration template by scriptName. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -296,19 +311,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk # Service Desk integration template by scriptName try { - Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName + Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName + # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-service-desk-integration-types This API endpoint returns the current list of supported Service Desk integration types. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-service-desk-integration-types) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -337,7 +355,7 @@ Code | Description | Data Type # List Service Desk integration types try { - Get-BetaServiceDeskIntegrationTypes + Get-BetaServiceDeskIntegrationTypes # Below is a request that includes all optional parameters # Get-BetaServiceDeskIntegrationTypes @@ -347,9 +365,12 @@ try { } ``` [[Back to top]](#) + ## get-status-check-details Get the time check configuration of queued SDIM tickets. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-status-check-details) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -378,7 +399,7 @@ Code | Description | Data Type # Get the time check configuration try { - Get-BetaStatusCheckDetails + Get-BetaStatusCheckDetails # Below is a request that includes all optional parameters # Get-BetaStatusCheckDetails @@ -388,9 +409,12 @@ try { } ``` [[Back to top]](#) + ## patch-service-desk-integration Update an existing Service Desk integration by ID with a PATCH request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -424,19 +448,22 @@ $PatchServiceDeskIntegrationRequest = @""@ try { $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $Result + Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest + # Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-service-desk-integration Update an existing Service Desk integration by ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -500,19 +527,22 @@ $ServiceDeskIntegrationDto = @"{ try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $Result + Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto + # Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-status-check-details Update the time check configuration of queued SDIM tickets. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-status-check-details) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -547,10 +577,10 @@ $QueuedCheckConfigDetails = @"{ try { $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result + Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result # Below is a request that includes all optional parameters - # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $QueuedCheckConfigDetails + # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourceUsagesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourceUsagesApi.md index 9fea752ea..75f78568c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourceUsagesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourceUsagesApi.md @@ -23,9 +23,12 @@ Method | HTTP request | Description [**Get-BetaStatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage [**Get-BetaUsagesBySourceId**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights + ## get-status-by-source-id This API returns the status of the source usage insights setup by IDN source ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-status-by-source-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -55,19 +58,22 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source # Finds status of source usage try { - Get-BetaStatusBySourceId -BetaSourceId $SourceId + Get-BetaStatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaStatusBySourceId -BetaSourceId $SourceId + # Get-BetaStatusBySourceId -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-usages-by-source-id This API returns a summary of source usage insights for past 12 months. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-usages-by-source-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -105,10 +111,10 @@ $Sorters = "-date" # String | Sort results using the standard syntax described i # Returns source usage insights try { - Get-BetaUsagesBySourceId -BetaSourceId $SourceId + Get-BetaUsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaUsagesBySourceId -BetaSourceId $SourceId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters + # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md index c03bed199..a633da212 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md @@ -118,11 +118,14 @@ Method | HTTP request | Description [**Update-BetaSourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{sourceId}/entitlement-request-config` | Update Source Entitlement Request Configuration [**Update-BetaSourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + ## create-provisioning-policy This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -195,20 +198,23 @@ $ProvisioningPolicyDto = @"{ try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaProvisioningPolicyDto $Result + New-BetaProvisioningPolicy -SourceId $SourceId -BetaProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # New-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaProvisioningPolicyDto $ProvisioningPolicyDto + # New-BetaProvisioningPolicy -SourceId $SourceId -BetaProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-source This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -323,19 +329,22 @@ $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures try { $Result = ConvertFrom-JsonToSource -Json $Source - New-BetaSource -BetaSource $Result + New-BetaSource -BetaSource $Result # Below is a request that includes all optional parameters - # New-BetaSource -BetaSource $Source -BetaProvisionAsCsv $ProvisionAsCsv + # New-BetaSource -BetaSource $Result -ProvisionAsCsv $ProvisionAsCsv } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-source-schema Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -401,21 +410,24 @@ $Schema = @"{ try { $Result = ConvertFrom-JsonToSchema -Json $Schema - New-BetaSourceSchema -BetaSourceId $SourceId -BetaSchema $Result + New-BetaSourceSchema -SourceId $SourceId -BetaSchema $Result # Below is a request that includes all optional parameters - # New-BetaSourceSchema -BetaSourceId $SourceId -BetaSchema $Schema + # New-BetaSourceSchema -SourceId $SourceId -BetaSchema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -446,16 +458,17 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. # Delete Source by ID try { - Remove-Beta -BetaId $Id + Remove-Beta -Id $Id # Below is a request that includes all optional parameters - # Remove-Beta -BetaId $Id + # Remove-Beta -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Beta" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-accounts-async Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. @@ -465,6 +478,8 @@ This endpoint is good for: * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-accounts-async) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -494,20 +509,23 @@ $SourceId = "ebbf35756e1140699ce52b233121384a" # String | The source id # Remove All Accounts in a Source try { - Remove-BetaAccountsAsync -BetaSourceId $SourceId + Remove-BetaAccountsAsync -SourceId $SourceId # Below is a request that includes all optional parameters - # Remove-BetaAccountsAsync -BetaSourceId $SourceId + # Remove-BetaAccountsAsync -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountsAsync" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-native-change-detection-config Deletes the native change detection configuration for the source specified by the given ID. A token with API, or ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-native-change-detection-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -538,19 +556,22 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id # Delete Native Change Detection Configuration try { - Remove-BetaNativeChangeDetectionConfig -BetaSourceId $SourceId + Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId # Below is a request that includes all optional parameters - # Remove-BetaNativeChangeDetectionConfig -BetaSourceId $SourceId + # Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNativeChangeDetectionConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-provisioning-policy Deletes the provisioning policy with the specified usage on an application. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -583,19 +604,22 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I # Delete Provisioning Policy by UsageType try { - Remove-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType + Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType # Below is a request that includes all optional parameters - # Remove-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType + # Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-source-schema +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -628,19 +652,22 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. # Delete Source Schema by ID try { - Remove-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId + Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId # Below is a request that includes all optional parameters - # Remove-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId + # Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-correlation-config This API returns the existing correlation configuration for a source specified by the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-correlation-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -671,20 +698,23 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id # Get Source Correlation Configuration try { - Get-BetaCorrelationConfig -BetaSourceId $SourceId + Get-BetaCorrelationConfig -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaCorrelationConfig -BetaSourceId $SourceId + # Get-BetaCorrelationConfig -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCorrelationConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-native-change-detection-config This API returns the existing native change detection configuration for a source specified by the given ID. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-native-change-detection-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -715,19 +745,22 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id # Native Change Detection Configuration try { - Get-BetaNativeChangeDetectionConfig -BetaSourceId $SourceId + Get-BetaNativeChangeDetectionConfig -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaNativeChangeDetectionConfig -BetaSourceId $SourceId + # Get-BetaNativeChangeDetectionConfig -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNativeChangeDetectionConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-provisioning-policy This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -760,20 +793,23 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I # Get Provisioning Policy by UsageType try { - Get-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType + Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType # Below is a request that includes all optional parameters - # Get-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType + # Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source Use this API to get a source by a specified ID in Identity Security Cloud (ISC). A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -804,19 +840,22 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. # Get Source by ID try { - Get-BetaSource -BetaId $Id + Get-BetaSource -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSource -BetaId $Id + # Get-BetaSource -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-accounts-schema +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-accounts-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -847,20 +886,23 @@ $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id # Downloads source accounts schema template try { - Get-BetaSourceAccountsSchema -BetaSourceId $SourceId + Get-BetaSourceAccountsSchema -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaSourceAccountsSchema -BetaSourceId $SourceId + # Get-BetaSourceAccountsSchema -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAccountsSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-attr-sync-config This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. A token with ORG_ADMIN or HELPDESK authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-attr-sync-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -891,20 +933,23 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id # Attribute Sync Config try { - Get-BetaSourceAttrSyncConfig -BetaId $Id + Get-BetaSourceAttrSyncConfig -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSourceAttrSyncConfig -BetaId $Id + # Get-BetaSourceAttrSyncConfig -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAttrSyncConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-config Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -936,16 +981,17 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale # Gets source config with language translations try { - Get-BetaSourceConfig -BetaId $Id + Get-BetaSourceConfig -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSourceConfig -BetaId $Id -BetaLocale $Locale + # Get-BetaSourceConfig -Id $Id -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-entitlement-request-config This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. @@ -955,6 +1001,8 @@ Access request to any entitlements in the source should follow this configuratio A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-entitlement-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -984,19 +1032,22 @@ $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id # Get Source Entitlement Request Configuration try { - Get-BetaSourceEntitlementRequestConfig -BetaSourceId $SourceId + Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaSourceEntitlementRequestConfig -BetaSourceId $SourceId + # Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-entitlements-schema +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-entitlements-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1029,20 +1080,23 @@ $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optiona # Downloads source entitlements schema template try { - Get-BetaSourceEntitlementsSchema -BetaSourceId $SourceId + Get-BetaSourceEntitlementsSchema -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaSourceEntitlementsSchema -BetaSourceId $SourceId -BetaSchemaName $SchemaName + # Get-BetaSourceEntitlementsSchema -SourceId $SourceId -SchemaName $SchemaName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementsSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-schema Get the Source Schema by ID in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1075,19 +1129,22 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. # Get Source Schema by ID try { - Get-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId + Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId # Below is a request that includes all optional parameters - # Get-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId + # Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-schemas Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-source-schemas) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1122,22 +1179,25 @@ $IncludeNames = "account" # String | A comma-separated list of schema names to f # List Schemas on Source try { - Get-BetaSourceSchemas -BetaSourceId $SourceId + Get-BetaSourceSchemas -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaSourceSchemas -BetaSourceId $SourceId -BetaIncludeTypes $IncludeTypes -BetaIncludeNames $IncludeNames + # Get-BetaSourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchemas" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-accounts Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-accounts) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1171,22 +1231,25 @@ $DisableOptimization = "true" # String | Use this flag to reprocess every accoun # Account Aggregation try { - Import-BetaAccounts -BetaSourceId $SourceId + Import-BetaAccounts -SourceId $SourceId # Below is a request that includes all optional parameters - # Import-BetaAccounts -BetaSourceId $SourceId -BetaFile $File -BetaDisableOptimization $DisableOptimization + # Import-BetaAccounts -SourceId $SourceId -File $File -DisableOptimization $DisableOptimization } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaAccounts" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-entitlements Starts an entitlement aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1218,19 +1281,22 @@ $File = # System.IO.FileInfo | The CSV file containing the source entitlements # Entitlement Aggregation try { - Import-BetaEntitlements -BetaSourceId $SourceId + Import-BetaEntitlements -SourceId $SourceId # Below is a request that includes all optional parameters - # Import-BetaEntitlements -BetaSourceId $SourceId -BetaFile $File + # Import-BetaEntitlements -SourceId $SourceId -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-source-accounts-schema This API uploads a source schema template file to configure a source's account attributes. +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-source-accounts-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1262,20 +1328,23 @@ $File = # System.IO.FileInfo | (optional) # Uploads source accounts schema template try { - Import-BetaSourceAccountsSchema -BetaSourceId $SourceId + Import-BetaSourceAccountsSchema -SourceId $SourceId # Below is a request that includes all optional parameters - # Import-BetaSourceAccountsSchema -BetaSourceId $SourceId -BetaFile $File + # Import-BetaSourceAccountsSchema -SourceId $SourceId -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceAccountsSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-source-connector-file This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-source-connector-file) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1307,19 +1376,22 @@ $File = # System.IO.FileInfo | (optional) # Upload connector file to source try { - Import-BetaSourceConnectorFile -BetaSourceId $SourceId + Import-BetaSourceConnectorFile -SourceId $SourceId # Below is a request that includes all optional parameters - # Import-BetaSourceConnectorFile -BetaSourceId $SourceId -BetaFile $File + # Import-BetaSourceConnectorFile -SourceId $SourceId -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceConnectorFile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-source-entitlements-schema This API uploads a source schema template file to configure a source's entitlement attributes. +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-source-entitlements-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1353,19 +1425,22 @@ $File = # System.IO.FileInfo | (optional) # Uploads source entitlements schema template try { - Import-BetaSourceEntitlementsSchema -BetaSourceId $SourceId + Import-BetaSourceEntitlementsSchema -SourceId $SourceId # Below is a request that includes all optional parameters - # Import-BetaSourceEntitlementsSchema -BetaSourceId $SourceId -BetaSchemaName $SchemaName -BetaFile $File + # Import-BetaSourceEntitlementsSchema -SourceId $SourceId -SchemaName $SchemaName -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceEntitlementsSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-uncorrelated-accounts File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` +[API Spec](https://developer.sailpoint.com/docs/api/beta/import-uncorrelated-accounts) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1397,19 +1472,22 @@ $File = # System.IO.FileInfo | (optional) # Process Uncorrelated Accounts try { - Import-BetaUncorrelatedAccounts -BetaSourceId $SourceId + Import-BetaUncorrelatedAccounts -SourceId $SourceId # Below is a request that includes all optional parameters - # Import-BetaUncorrelatedAccounts -BetaSourceId $SourceId -BetaFile $File + # Import-BetaUncorrelatedAccounts -SourceId $SourceId -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaUncorrelatedAccounts" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-provisioning-policies This end-point lists all the ProvisioningPolicies in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-provisioning-policies) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1440,21 +1518,24 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id # Lists ProvisioningPolicies try { - Get-BetaProvisioningPolicies -BetaSourceId $SourceId + Get-BetaProvisioningPolicies -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-BetaProvisioningPolicies -BetaSourceId $SourceId + # Get-BetaProvisioningPolicies -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicies" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-sources This end-point lists all the sources in IdentityNow. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-sources) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1497,20 +1578,23 @@ $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the resp # Lists all sources in IdentityNow. try { - Get-BetaSources + Get-BetaSources # Below is a request that includes all optional parameters - # Get-BetaSources -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSubadmin $ForSubadmin -BetaIncludeIDNSource $IncludeIDNSource + # Get-BetaSources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSources" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## peek-resource-objects Retrieves a sample of data returned from account and group aggregation requests. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/peek-resource-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1547,20 +1631,23 @@ $ResourceObjectsRequest = @"{ try { $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest - Receive-BetaResourceObjects -BetaSourceId $SourceId -BetaResourceObjectsRequest $Result + Receive-BetaResourceObjects -SourceId $SourceId -BetaResourceObjectsRequest $Result # Below is a request that includes all optional parameters - # Receive-BetaResourceObjects -BetaSourceId $SourceId -BetaResourceObjectsRequest $ResourceObjectsRequest + # Receive-BetaResourceObjects -SourceId $SourceId -BetaResourceObjectsRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-BetaResourceObjects" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## ping-cluster This endpoint validates that the cluster being used by the source is reachable from IdentityNow. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/ping-cluster) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1591,19 +1678,22 @@ $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source # Ping cluster for source connector try { - Ping-BetaCluster -BetaSourceId $SourceId + Ping-BetaCluster -SourceId $SourceId # Below is a request that includes all optional parameters - # Ping-BetaCluster -BetaSourceId $SourceId + # Ping-BetaCluster -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaCluster" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-correlation-config Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-correlation-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1657,21 +1747,24 @@ $CorrelationConfig = @"{ try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig - Send-BetaCorrelationConfig -BetaSourceId $SourceId -BetaCorrelationConfig $Result + Send-BetaCorrelationConfig -SourceId $SourceId -BetaCorrelationConfig $Result # Below is a request that includes all optional parameters - # Send-BetaCorrelationConfig -BetaSourceId $SourceId -BetaCorrelationConfig $CorrelationConfig + # Send-BetaCorrelationConfig -SourceId $SourceId -BetaCorrelationConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaCorrelationConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-native-change-detection-config Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-native-change-detection-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1712,21 +1805,24 @@ $NativeChangeDetectionConfig = @"{ try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig - Send-BetaNativeChangeDetectionConfig -BetaSourceId $SourceId -BetaNativeChangeDetectionConfig $Result + Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -BetaNativeChangeDetectionConfig $Result # Below is a request that includes all optional parameters - # Send-BetaNativeChangeDetectionConfig -BetaSourceId $SourceId -BetaNativeChangeDetectionConfig $NativeChangeDetectionConfig + # Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -BetaNativeChangeDetectionConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNativeChangeDetectionConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-provisioning-policy This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1801,16 +1897,17 @@ $ProvisioningPolicyDto = @"{ try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaProvisioningPolicyDto $Result + Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -BetaProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Send-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaProvisioningPolicyDto $ProvisioningPolicyDto + # Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -BetaProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-source Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. @@ -1828,6 +1925,8 @@ Attempts to modify these fields will result in a 400 error. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1943,21 +2042,24 @@ $Source = @"{ try { $Result = ConvertFrom-JsonToSource -Json $Source - Send-BetaSource -BetaId $Id -BetaSource $Result + Send-BetaSource -Id $Id -BetaSource $Result # Below is a request that includes all optional parameters - # Send-BetaSource -BetaId $Id -BetaSource $Source + # Send-BetaSource -Id $Id -BetaSource $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-source-attr-sync-config Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-source-attr-sync-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2008,16 +2110,17 @@ $AttrSyncSourceConfig = @"{ try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig - Send-BetaSourceAttrSyncConfig -BetaId $Id -BetaAttrSyncSourceConfig $Result + Send-BetaSourceAttrSyncConfig -Id $Id -BetaAttrSyncSourceConfig $Result # Below is a request that includes all optional parameters - # Send-BetaSourceAttrSyncConfig -BetaId $Id -BetaAttrSyncSourceConfig $AttrSyncSourceConfig + # Send-BetaSourceAttrSyncConfig -Id $Id -BetaAttrSyncSourceConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceAttrSyncConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-source-schema This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. * id @@ -2026,6 +2129,8 @@ This API will completely replace an existing Schema with the submitted payload. * modified Any attempt to modify these fields will result in an error response with a status code of 400. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2094,20 +2199,23 @@ $Schema = @"{ try { $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaSchema $Result + Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -BetaSchema $Result # Below is a request that includes all optional parameters - # Send-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaSchema $Schema + # Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -BetaSchema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## sync-attributes-for-source This end-point performs attribute synchronization for a selected source. A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/sync-attributes-for-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2138,20 +2246,23 @@ $SourceId = "MySourceId" # String | The Source id # Synchronize single source attributes. try { - Sync-BetaAttributesForSource -BetaSourceId $SourceId + Sync-BetaAttributesForSource -SourceId $SourceId # Below is a request that includes all optional parameters - # Sync-BetaAttributesForSource -BetaSourceId $SourceId + # Sync-BetaAttributesForSource -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaAttributesForSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-source-configuration 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. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-source-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2182,20 +2293,23 @@ $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source # Test configuration for source connector try { - Test-BetaSourceConfiguration -BetaSourceId $SourceId + Test-BetaSourceConfiguration -SourceId $SourceId # Below is a request that includes all optional parameters - # Test-BetaSourceConfiguration -BetaSourceId $SourceId + # Test-BetaSourceConfiguration -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-source-connection This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-source-connection) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2226,19 +2340,22 @@ $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. # Check connection for source connector. try { - Test-BetaSourceConnection -BetaSourceId $SourceId + Test-BetaSourceConnection -SourceId $SourceId # Below is a request that includes all optional parameters - # Test-BetaSourceConnection -BetaSourceId $SourceId + # Test-BetaSourceConnection -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnection" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-provisioning-policies-in-bulk This end-point updates a list of provisioning policies on the specified source in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-provisioning-policies-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2312,21 +2429,24 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-BetaProvisioningPoliciesInBulk -BetaSourceId $SourceId -BetaProvisioningPolicyDto $Result + Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -BetaProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Update-BetaProvisioningPoliciesInBulk -BetaSourceId $SourceId -BetaProvisioningPolicyDto $ProvisioningPolicyDto + # Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -BetaProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPoliciesInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-provisioning-policy This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2367,16 +2487,17 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaJsonPatchOperation $Result + Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-source Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -2396,6 +2517,8 @@ Attempts to modify these fields will result in a 400 error. A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2434,16 +2557,17 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSource -BetaId $Id -BetaJsonPatchOperation $Result + Update-BetaSource -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaSource -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaSource -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-source-entitlement-request-config This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. @@ -2453,6 +2577,8 @@ Access request to any entitlements in the source should follow this configuratio A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-source-entitlement-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2497,16 +2623,17 @@ $SourceEntitlementRequestConfig = @"{ try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-BetaSourceEntitlementRequestConfig -BetaSourceId $SourceId -BetaSourceEntitlementRequestConfig $Result + Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -BetaSourceEntitlementRequestConfig $Result # Below is a request that includes all optional parameters - # Update-BetaSourceEntitlementRequestConfig -BetaSourceId $SourceId -BetaSourceEntitlementRequestConfig $SourceEntitlementRequestConfig + # Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -BetaSourceEntitlementRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-source-schema Use this API to selectively update an existing Schema using a JSONPatch payload. @@ -2539,6 +2666,8 @@ To switch an account attribute to a group entitlement, you need to have the foll ``` +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2579,10 +2708,10 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaJsonPatchOperation $Result + Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md index cf1489361..8687ba1d6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md @@ -28,6 +28,7 @@ Method | HTTP request | Description [**Submit-BetaSedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request [**Submit-BetaSedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request + ## get-sed-batch-stats Submit Sed Batch Stats Request. @@ -35,6 +36,8 @@ Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batch-stats) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -65,20 +68,23 @@ $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id # Submit Sed Batch Stats Request try { - Get-BetaSedBatchStats -BetaBatchId $BatchId + Get-BetaSedBatchStats -BatchId $BatchId # Below is a request that includes all optional parameters - # Get-BetaSedBatchStats -BetaBatchId $BatchId + # Get-BetaSedBatchStats -BatchId $BatchId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sed-batches List Sed Batches. API responses with Sed Batch Status +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batches) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -107,7 +113,7 @@ Code | Description | Data Type # List Sed Batch Request try { - Get-BetaSedBatches + Get-BetaSedBatches # Below is a request that includes all optional parameters # Get-BetaSedBatches @@ -117,6 +123,7 @@ try { } ``` [[Back to top]](#) + ## list-seds List of Suggested Entitlement Descriptions (SED) @@ -134,6 +141,8 @@ SED field descriptions: **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-seds) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -176,19 +185,22 @@ $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are # List Suggested Entitlement Descriptions try { - Get-BetaSeds + Get-BetaSeds # Below is a request that includes all optional parameters - # Get-BetaSeds -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters -BetaCount $Count -BetaCountOnly $CountOnly -BetaRequestedByAnyone $RequestedByAnyone -BetaShowPendingStatusOnly $ShowPendingStatusOnly + # Get-BetaSeds -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSeds" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-sed Patch Suggested Entitlement Description +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-sed) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -227,20 +239,23 @@ $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-BetaSed -BetaId $Id -BetaSedPatch $Result + Update-BetaSed -Id $Id -BetaSedPatch $Result # Below is a request that includes all optional parameters - # Update-BetaSed -BetaId $Id -BetaSedPatch $SedPatch + # Update-BetaSed -Id $Id -BetaSedPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-sed-approval Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-approval) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -275,20 +290,23 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-BetaSedApproval -BetaSedApproval $Result + Submit-BetaSedApproval -BetaSedApproval $Result # Below is a request that includes all optional parameters - # Submit-BetaSedApproval -BetaSedApproval $SedApproval + # Submit-BetaSedApproval -BetaSedApproval $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-sed-assignment Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-assignment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -326,16 +344,17 @@ $SedAssignment = @"{ try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-BetaSedAssignment -BetaSedAssignment $Result + Submit-BetaSedAssignment -BetaSedAssignment $Result # Below is a request that includes all optional parameters - # Submit-BetaSedAssignment -BetaSedAssignment $SedAssignment + # Submit-BetaSedAssignment -BetaSedAssignment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-sed-batch-request Submit Sed Batch Request. Request body has one of the following: @@ -343,6 +362,8 @@ Request body has one of the following: - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-sed-batch-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -376,10 +397,10 @@ $SedBatchRequest = @"{ # Submit Sed Batch Request try { - Submit-BetaSedBatchRequest + Submit-BetaSedBatchRequest # Below is a request that includes all optional parameters - # Submit-BetaSedBatchRequest -BetaSedBatchRequest $SedBatchRequest + # Submit-BetaSedBatchRequest -BetaSedBatchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md index 3de03686f..2edb76507 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md @@ -79,9 +79,12 @@ Method | HTTP request | Description [**Set-BetaTagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object [**Set-BetaTagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects + ## delete-tagged-object Delete all tags from a tagged object. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tagged-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -113,21 +116,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to dele # Delete Object Tags try { - Remove-BetaTaggedObject -BetaType $Type -BetaId $Id + Remove-BetaTaggedObject -Type $Type -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaTaggedObject -BetaType $Type -BetaId $Id + # Remove-BetaTaggedObject -Type $Type -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTaggedObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-tags-to-many-object This API removes tags from multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tags-to-many-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -170,19 +176,22 @@ $BulkTaggedObject = @"{ try { $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject - Remove-BetaTagsToManyObject -BetaBulkTaggedObject $Result + Remove-BetaTagsToManyObject -BetaBulkTaggedObject $Result # Below is a request that includes all optional parameters - # Remove-BetaTagsToManyObject -BetaBulkTaggedObject $BulkTaggedObject + # Remove-BetaTagsToManyObject -BetaBulkTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-tagged-object This gets a tagged object for the specified type. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tagged-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -214,21 +223,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen # Get Tagged Object try { - Get-BetaTaggedObject -BetaType $Type -BetaId $Id + Get-BetaTaggedObject -Type $Type -Id $Id # Below is a request that includes all optional parameters - # Get-BetaTaggedObject -BetaType $Type -BetaId $Id + # Get-BetaTaggedObject -Type $Type -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-tagged-objects This API returns a list of all tagged objects. Any authenticated token may be used to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-tagged-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -264,21 +276,24 @@ $Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standar # List Tagged Objects try { - Get-BetaTaggedObjects + Get-BetaTaggedObjects # Below is a request that includes all optional parameters - # Get-BetaTaggedObjects -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters + # Get-BetaTaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjects" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-tagged-objects-by-type This API returns a list of all tagged objects by type. Any authenticated token may be used to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-tagged-objects-by-type) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -316,19 +331,22 @@ $Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filte # List Tagged Objects by Type try { - Get-BetaTaggedObjectsByType -BetaType $Type + Get-BetaTaggedObjectsByType -Type $Type # Below is a request that includes all optional parameters - # Get-BetaTaggedObjectsByType -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters + # Get-BetaTaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjectsByType" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-tagged-object This updates a tagged object for the specified type. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-tagged-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -370,21 +388,24 @@ $TaggedObject = @"{ try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-BetaTaggedObject -BetaType $Type -BetaId $Id -BetaTaggedObject $Result + Send-BetaTaggedObject -Type $Type -Id $Id -BetaTaggedObject $Result # Below is a request that includes all optional parameters - # Send-BetaTaggedObject -BetaType $Type -BetaId $Id -BetaTaggedObject $TaggedObject + # Send-BetaTaggedObject -Type $Type -Id $Id -BetaTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-tag-to-object This adds a tag to an object. Any authenticated token may be used to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-tag-to-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -422,21 +443,24 @@ $TaggedObject = @"{ try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-BetaTagToObject -BetaTaggedObject $Result + Set-BetaTagToObject -BetaTaggedObject $Result # Below is a request that includes all optional parameters - # Set-BetaTagToObject -BetaTaggedObject $TaggedObject + # Set-BetaTagToObject -BetaTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-tags-to-many-objects This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-tags-to-many-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -479,10 +503,10 @@ $BulkTaggedObject = @"{ try { $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject - Set-BetaTagsToManyObjects -BetaBulkTaggedObject $Result + Set-BetaTagsToManyObjects -BetaBulkTaggedObject $Result # Below is a request that includes all optional parameters - # Set-BetaTagsToManyObjects -BetaBulkTaggedObject $BulkTaggedObject + # Set-BetaTagsToManyObjects -BetaBulkTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagsToManyObjects" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md index f0dfe5be2..91fd3c73c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md @@ -22,11 +22,14 @@ Method | HTTP request | Description [**Get-BetaTagById**](#get-tag-by-id) | **GET** `/tags/{id}` | Get Tag By Id [**Get-BetaTags**](#list-tags) | **GET** `/tags` | List Tags + ## create-tag This API creates new tag. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-tag) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -71,21 +74,24 @@ $Tag = @"{ try { $Result = ConvertFrom-JsonToTag -Json $Tag - New-BetaTag -BetaTag $Result + New-BetaTag -BetaTag $Result # Below is a request that includes all optional parameters - # New-BetaTag -BetaTag $Tag + # New-BetaTag -BetaTag $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-tag-by-id This API deletes a tag by specified id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-tag-by-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -116,21 +122,24 @@ $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object ref # Delete Tag try { - Remove-BetaTagById -BetaId $Id + Remove-BetaTagById -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaTagById -BetaId $Id + # Remove-BetaTagById -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagById" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-tag-by-id Returns a tag by its id. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tag-by-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -161,21 +170,24 @@ $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object ref # Get Tag By Id try { - Get-BetaTagById -BetaId $Id + Get-BetaTagById -Id $Id # Below is a request that includes all optional parameters - # Get-BetaTagById -BetaId $Id + # Get-BetaTagById -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTagById" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-tags This API returns a list of tags. A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-tags) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -213,10 +225,10 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List Tags try { - Get-BetaTags + Get-BetaTags # Below is a request that includes all optional parameters - # Get-BetaTags -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaTags -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTags" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md index 83ccdd2f1..b9df756c8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md @@ -23,9 +23,12 @@ Method | HTTP request | Description [**Get-BetaTaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List [**Update-BetaTaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID + ## get-pending-task-headers Responds with headers only for list of task statuses for pending tasks. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-pending-task-headers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -60,19 +63,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieve Pending Task List Headers try { - Get-BetaPendingTaskHeaders + Get-BetaPendingTaskHeaders # Below is a request that includes all optional parameters - # Get-BetaPendingTaskHeaders -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaPendingTaskHeaders -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTaskHeaders" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-pending-tasks Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -107,19 +113,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieve Pending Task Status List try { - Get-BetaPendingTasks + Get-BetaPendingTasks # Below is a request that includes all optional parameters - # Get-BetaPendingTasks -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + # Get-BetaPendingTasks -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTasks" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-task-status Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-task-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -150,20 +159,23 @@ $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. # Get Task Status by ID try { - Get-BetaTaskStatus -BetaId $Id + Get-BetaTaskStatus -Id $Id # Below is a request that includes all optional parameters - # Get-BetaTaskStatus -BetaId $Id + # Get-BetaTaskStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-task-status-list Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-task-status-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -202,19 +214,22 @@ $Sorters = "-created" # String | Sort results using the standard syntax describe # Retrieve Task Status List try { - Get-BetaTaskStatusList + Get-BetaTaskStatusList # Below is a request that includes all optional parameters - # Get-BetaTaskStatusList -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaTaskStatusList -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatusList" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-task-status Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-task-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -253,10 +268,10 @@ $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaTaskStatus -BetaId $Id -BetaJsonPatchOperation $Result + Update-BetaTaskStatus -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaTaskStatus -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaTaskStatus -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTaskStatus" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTenantApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTenantApi.md index d9a279d05..469c26064 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTenantApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTenantApi.md @@ -19,9 +19,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-BetaTenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information. + ## get-tenant This rest endpoint can be used to retrieve tenant details. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -50,7 +53,7 @@ Code | Description | Data Type # Get Tenant Information. try { - Get-BetaTenant + Get-BetaTenant # Below is a request that includes all optional parameters # Get-BetaTenant diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md index e900cb146..7f2e0476a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md @@ -23,9 +23,12 @@ Method | HTTP request | Description [**Get-BetaTransforms**](#list-transforms) | **GET** `/transforms` | List transforms [**Update-BetaTransform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform + ## create-transform Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -77,20 +80,23 @@ $Transform = @"{ try { $Result = ConvertFrom-JsonToTransform -Json $Transform - New-BetaTransform -BetaTransform $Result + New-BetaTransform -BetaTransform $Result # Below is a request that includes all optional parameters - # New-BetaTransform -BetaTransform $Transform + # New-BetaTransform -BetaTransform $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-transform Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. A token with transform delete authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -121,20 +127,23 @@ $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete # Delete a transform try { - Remove-BetaTransform -BetaId $Id + Remove-BetaTransform -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaTransform -BetaId $Id + # Remove-BetaTransform -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTransform" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-transform This API returns the transform specified by the given ID. A token with transform read authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -165,20 +174,23 @@ $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retriev # Transform by ID try { - Get-BetaTransform -BetaId $Id + Get-BetaTransform -Id $Id # Below is a request that includes all optional parameters - # Get-BetaTransform -BetaId $Id + # Get-BetaTransform -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransform" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-transforms Gets a list of all saved transform objects. A token with transforms-list read authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-transforms) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -217,20 +229,23 @@ $Filters = 'name eq "Uppercase"' # String | Filter results using the standard sy # List transforms try { - Get-BetaTransforms + Get-BetaTransforms # Below is a request that includes all optional parameters - # Get-BetaTransforms -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaName $Name -BetaFilters $Filters + # Get-BetaTransforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransforms" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-transform Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. A token with transform write authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -283,10 +298,10 @@ $Transform = @"{ # Update a transform try { - Update-BetaTransform -BetaId $Id + Update-BetaTransform -Id $Id # Below is a request that includes all optional parameters - # Update-BetaTransform -BetaId $Id -BetaTransform $Transform + # Update-BetaTransform -Id $Id -BetaTransform $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTransform" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md index 22a827ae3..ede7f30e4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md @@ -69,9 +69,12 @@ Method | HTTP request | Description [**Test-BetaSubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter [**Update-BetaSubscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription + ## complete-trigger-invocation Completes an invocation to a REQUEST_RESPONSE type trigger. +[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-trigger-invocation) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -110,21 +113,24 @@ $CompleteInvocation = @"{ try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation - Complete-BetaTriggerInvocation -BetaId $Id -BetaCompleteInvocation $Result + Complete-BetaTriggerInvocation -Id $Id -BetaCompleteInvocation $Result # Below is a request that includes all optional parameters - # Complete-BetaTriggerInvocation -BetaId $Id -BetaCompleteInvocation $CompleteInvocation + # Complete-BetaTriggerInvocation -Id $Id -BetaCompleteInvocation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-subscription This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-subscription) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -179,19 +185,22 @@ $SubscriptionPostRequest = @"{ try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest - New-BetaSubscription -BetaSubscriptionPostRequest $Result + New-BetaSubscription -BetaSubscriptionPostRequest $Result # Below is a request that includes all optional parameters - # New-BetaSubscription -BetaSubscriptionPostRequest $SubscriptionPostRequest + # New-BetaSubscription -BetaSubscriptionPostRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-subscription Deletes an existing subscription to a trigger. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-subscription) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -222,19 +231,22 @@ $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID # Delete a Subscription try { - Remove-BetaSubscription -BetaId $Id + Remove-BetaSubscription -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaSubscription -BetaId $Id + # Remove-BetaSubscription -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSubscription" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-subscriptions Gets a list of all trigger subscriptions. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-subscriptions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -272,21 +284,24 @@ $Sorters = "triggerName" # String | Sort results using the standard syntax descr # List Subscriptions try { - Get-BetaSubscriptions + Get-BetaSubscriptions # Below is a request that includes all optional parameters - # Get-BetaSubscriptions -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaSubscriptions -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSubscriptions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-trigger-invocation-status Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-trigger-invocation-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -324,19 +339,22 @@ $Sorters = "created" # String | Sort results using the standard syntax described # List Latest Invocation Statuses try { - Get-BetaTriggerInvocationStatus + Get-BetaTriggerInvocationStatus # Below is a request that includes all optional parameters - # Get-BetaTriggerInvocationStatus -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaTriggerInvocationStatus -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggerInvocationStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-triggers Gets a list of triggers that are available in the tenant. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-triggers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -374,21 +392,24 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # List Triggers try { - Get-BetaTriggers + Get-BetaTriggers # Below is a request that includes all optional parameters - # Get-BetaTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + # Get-BetaTriggers -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-subscription This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-subscription) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -423,19 +444,22 @@ $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription t try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner - Update-BetaSubscription -BetaId $Id -BetaSubscriptionPatchRequestInner $Result + Update-BetaSubscription -Id $Id -BetaSubscriptionPatchRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaSubscription -BetaId $Id -BetaSubscriptionPatchRequestInner $SubscriptionPatchRequestInner + # Update-BetaSubscription -Id $Id -BetaSubscriptionPatchRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-test-trigger-invocation Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. +[API Spec](https://developer.sailpoint.com/docs/api/beta/start-test-trigger-invocation) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -476,20 +500,23 @@ $TestInvocation = @"{ try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation - Start-BetaTestTriggerInvocation -BetaTestInvocation $Result + Start-BetaTestTriggerInvocation -BetaTestInvocation $Result # Below is a request that includes all optional parameters - # Start-BetaTestTriggerInvocation -BetaTestInvocation $TestInvocation + # Start-BetaTestTriggerInvocation -BetaTestInvocation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-subscription-filter Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-subscription-filter) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -525,16 +552,17 @@ $ValidateFilterInputDto = @"{ try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto - Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $Result + Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $Result # Below is a request that includes all optional parameters - # Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $ValidateFilterInputDto + # Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-subscription This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: @@ -547,6 +575,8 @@ This API updates a trigger subscription in IdentityNow, using a full object repr Attempts to modify these fields result in 400. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-subscription) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -603,10 +633,10 @@ $SubscriptionPutRequest = @"{ try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest - Update-BetaSubscription -BetaId $Id -BetaSubscriptionPutRequest $Result + Update-BetaSubscription -Id $Id -BetaSubscriptionPutRequest $Result # Below is a request that includes all optional parameters - # Update-BetaSubscription -BetaId $Id -BetaSubscriptionPutRequest $SubscriptionPutRequest + # Update-BetaSubscription -Id $Id -BetaSubscriptionPutRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md index 09b6d798c..0ac123a3d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md @@ -21,10 +21,13 @@ Method | HTTP request | Description [**Get-BetaTenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata [**Set-BetaTenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata + ## get-tenant-ui-metadata This API endpoint retrieves UI metadata configured for your tenant. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant-ui-metadata) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -53,7 +56,7 @@ Code | Description | Data Type # Get a tenant UI metadata try { - Get-BetaTenantUiMetadata + Get-BetaTenantUiMetadata # Below is a request that includes all optional parameters # Get-BetaTenantUiMetadata @@ -63,10 +66,13 @@ try { } ``` [[Back to top]](#) + ## set-tenant-ui-metadata This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/beta/set-tenant-ui-metadata) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -102,10 +108,10 @@ $TenantUiMetadataItemUpdateRequest = @"{ try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest - Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $Result + Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $Result # Below is a request that includes all optional parameters - # Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest + # Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md index 0a834f58a..1a8c19785 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md @@ -25,10 +25,13 @@ Method | HTTP request | Description [**Remove-BetaVendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping [**Get-BetaVendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings + ## create-vendor-connector-mapping Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-vendor-connector-mapping) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -82,20 +85,23 @@ $VendorConnectorMapping = @"{ try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-BetaVendorConnectorMapping -BetaVendorConnectorMapping $Result + New-BetaVendorConnectorMapping -BetaVendorConnectorMapping $Result # Below is a request that includes all optional parameters - # New-BetaVendorConnectorMapping -BetaVendorConnectorMapping $VendorConnectorMapping + # New-BetaVendorConnectorMapping -BetaVendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVendorConnectorMapping" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-vendor-connector-mapping Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-vendor-connector-mapping) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -149,20 +155,23 @@ $VendorConnectorMapping = @"{ try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-BetaVendorConnectorMapping -BetaVendorConnectorMapping $Result + Remove-BetaVendorConnectorMapping -BetaVendorConnectorMapping $Result # Below is a request that includes all optional parameters - # Remove-BetaVendorConnectorMapping -BetaVendorConnectorMapping $VendorConnectorMapping + # Remove-BetaVendorConnectorMapping -BetaVendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVendorConnectorMapping" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-vendor-connector-mappings Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-vendor-connector-mappings) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -191,7 +200,7 @@ Code | Description | Data Type # List Vendor Connector Mappings try { - Get-BetaVendorConnectorMappings + Get-BetaVendorConnectorMappings # Below is a request that includes all optional parameters # Get-BetaVendorConnectorMappings diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md index 59e7da03e..4202b153a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md @@ -45,9 +45,12 @@ Method | HTTP request | Description [**Deny-BetaApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items [**Submit-BetaAccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections + ## approve-approval-item This API approves an Approval Item. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-approval-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -77,19 +80,22 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap # Approve an Approval Item try { - Approve-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId + Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Approve-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId + # Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## approve-approval-items-in-bulk This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/approve-approval-items-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -117,19 +123,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item # Bulk approve Approval Items try { - Approve-BetaApprovalItemsInBulk -BetaId $Id + Approve-BetaApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Approve-BetaApprovalItemsInBulk -BetaId $Id + # Approve-BetaApprovalItemsInBulk -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## complete-work-item This API completes a work item. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/complete-work-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,19 +166,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item # Complete a Work Item try { - Complete-BetaWorkItem -BetaId $Id + Complete-BetaWorkItem -Id $Id # Below is a request that includes all optional parameters - # Complete-BetaWorkItem -BetaId $Id + # Complete-BetaWorkItem -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## forward-work-item This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/forward-work-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -206,19 +218,22 @@ $WorkItemForward = @"{ try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-BetaForwardWorkItem -BetaId $Id -BetaWorkItemForward $Result + Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result # Below is a request that includes all optional parameters - # Invoke-BetaForwardWorkItem -BetaId $Id -BetaWorkItemForward $WorkItemForward + # Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-completed-work-items This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-completed-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -252,19 +267,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Completed Work Items try { - Get-BetaCompletedWorkItems + Get-BetaCompletedWorkItems # Below is a request that includes all optional parameters - # Get-BetaCompletedWorkItems -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + # Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-count-completed-work-items This gets a count of completed work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-completed-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -292,19 +310,22 @@ $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) # Count Completed Work Items try { - Get-BetaCountCompletedWorkItems + Get-BetaCountCompletedWorkItems # Below is a request that includes all optional parameters - # Get-BetaCountCompletedWorkItems -BetaOwnerId $OwnerId + # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-count-work-items This gets a count of work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-count-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -332,19 +353,22 @@ $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) # Count Work Items try { - Get-BetaCountWorkItems + Get-BetaCountWorkItems # Below is a request that includes all optional parameters - # Get-BetaCountWorkItems -BetaOwnerId $OwnerId + # Get-BetaCountWorkItems -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-work-item This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-work-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -374,19 +398,22 @@ $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) # Get a Work Item try { - Get-BetaWorkItem -BetaId $Id + Get-BetaWorkItem -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkItem -BetaId $Id -BetaOwnerId $OwnerId + # Get-BetaWorkItem -Id $Id -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-work-items-summary This gets a summary of work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-work-items-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -414,19 +441,22 @@ $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) # Work Items Summary try { - Get-BetaWorkItemsSummary + Get-BetaWorkItemsSummary # Below is a request that includes all optional parameters - # Get-BetaWorkItemsSummary -BetaOwnerId $OwnerId + # Get-BetaWorkItemsSummary -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-work-items This gets a collection of work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -460,19 +490,22 @@ $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) # List Work Items try { - Get-BetaWorkItems + Get-BetaWorkItems # Below is a request that includes all optional parameters - # Get-BetaWorkItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaOwnerId $OwnerId + # Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reject-approval-item This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-approval-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -502,19 +535,22 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap # Reject an Approval Item try { - Deny-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId + Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Deny-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId + # Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reject-approval-items-in-bulk This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/reject-approval-items-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -542,19 +578,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item # Bulk reject Approval Items try { - Deny-BetaApprovalItemsInBulk -BetaId $Id + Deny-BetaApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Deny-BetaApprovalItemsInBulk -BetaId $Id + # Deny-BetaApprovalItemsInBulk -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-account-selection This API submits account selections. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/beta/submit-account-selection) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -585,10 +624,10 @@ $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Sele try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-BetaAccountSelection -BetaId $Id -BetaRequestBody $Result + Submit-BetaAccountSelection -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Submit-BetaAccountSelection -BetaId $Id -BetaRequestBody $RequestBody + # Submit-BetaAccountSelection -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md index 085e92925..85e5aabe1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md @@ -37,9 +37,12 @@ Method | HTTP request | Description [**Send-BetaReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration [**Send-BetaTenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings + ## create-reassignment-configuration Creates a new Reassignment Configuration for the specified identity. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-reassignment-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -76,19 +79,22 @@ $ConfigurationItemRequest = @"{ try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result + New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $ConfigurationItemRequest + # New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-reassignment-configuration Deletes a single reassignment configuration for the specified identity +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-reassignment-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -120,19 +126,22 @@ $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | # Delete Reassignment Configuration try { - Remove-BetaReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType + Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType # Below is a request that includes all optional parameters - # Remove-BetaReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType + # Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-evaluate-reassignment-configuration Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-evaluate-reassignment-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -168,19 +177,22 @@ $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # String[] | Exclusion filters th # Evaluate Reassignment Configuration try { - Get-BetaEvaluateReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType + Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType # Below is a request that includes all optional parameters - # Get-BetaEvaluateReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType -BetaExclusionFilters $ExclusionFilters + # Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-reassignment-config-types Gets a collection of types which are available in the Reassignment Configuration UI. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-reassignment-config-types) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -208,7 +220,7 @@ Code | Description | Data Type # List Reassignment Config Types try { - Get-BetaReassignmentConfigTypes + Get-BetaReassignmentConfigTypes # Below is a request that includes all optional parameters # Get-BetaReassignmentConfigTypes @@ -218,9 +230,12 @@ try { } ``` [[Back to top]](#) + ## get-reassignment-configuration Gets the Reassignment Configuration for an identity. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-reassignment-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -251,19 +266,22 @@ $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id # Get Reassignment Configuration try { - Get-BetaReassignmentConfiguration -BetaIdentityId $IdentityId + Get-BetaReassignmentConfiguration -IdentityId $IdentityId # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfiguration -BetaIdentityId $IdentityId + # Get-BetaReassignmentConfiguration -IdentityId $IdentityId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-tenant-config-configuration Gets the global Reassignment Configuration settings for the requestor's tenant. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant-config-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -292,7 +310,7 @@ Code | Description | Data Type # Get Tenant-wide Reassignment Configuration settings try { - Get-BetaTenantConfigConfiguration + Get-BetaTenantConfigConfiguration # Below is a request that includes all optional parameters # Get-BetaTenantConfigConfiguration @@ -302,9 +320,12 @@ try { } ``` [[Back to top]](#) + ## list-reassignment-configurations Gets all Reassignment configuration for the current org. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-reassignment-configurations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -333,7 +354,7 @@ Code | Description | Data Type # List Reassignment Configurations try { - Get-BetaReassignmentConfigurations + Get-BetaReassignmentConfigurations # Below is a request that includes all optional parameters # Get-BetaReassignmentConfigurations @@ -343,9 +364,12 @@ try { } ``` [[Back to top]](#) + ## put-reassignment-config Replaces existing Reassignment configuration for an identity with the newly provided configuration. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-reassignment-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -384,19 +408,22 @@ $ConfigurationItemRequest = @"{ try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-BetaReassignmentConfig -BetaIdentityId $IdentityId -BetaConfigurationItemRequest $Result + Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Send-BetaReassignmentConfig -BetaIdentityId $IdentityId -BetaConfigurationItemRequest $ConfigurationItemRequest + # Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-tenant-configuration Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-tenant-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -431,10 +458,10 @@ $TenantConfigurationRequest = @"{ try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result + Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result # Below is a request that includes all optional parameters - # Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $TenantConfigurationRequest + # Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md index dc553f3e2..5d2dda2ce 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md @@ -37,9 +37,12 @@ Method | HTTP request | Description [**Test-BetaWorkflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id [**Update-BetaWorkflow**](#update-workflow) | **PUT** `/workflows/{id}` | Update Workflow + ## cancel-workflow-execution Use this API to cancel a running workflow execution. +[API Spec](https://developer.sailpoint.com/docs/api/beta/cancel-workflow-execution) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -70,19 +73,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution I # Cancel Workflow Execution by ID try { - Suspend-BetaWorkflowExecution -BetaId $Id + Suspend-BetaWorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Suspend-BetaWorkflowExecution -BetaId $Id + # Suspend-BetaWorkflowExecution -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-workflow Create a new workflow with the desired trigger and steps specified in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/beta/create-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -113,19 +119,22 @@ $CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568 try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-BetaWorkflow -BetaCreateWorkflowRequest $Result + New-BetaWorkflow -BetaCreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # New-BetaWorkflow -BetaCreateWorkflowRequest $CreateWorkflowRequest + # New-BetaWorkflow -BetaCreateWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-workflow Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. +[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -155,19 +164,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow # Delete Workflow By Id try { - Remove-BetaWorkflow -BetaId $Id + Remove-BetaWorkflow -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaWorkflow -BetaId $Id + # Remove-BetaWorkflow -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-workflow Get a single workflow by id. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -197,19 +209,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow # Get Workflow By Id try { - Get-BetaWorkflow -BetaId $Id + Get-BetaWorkflow -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkflow -BetaId $Id + # Get-BetaWorkflow -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-workflow-execution Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -240,19 +255,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. # Get Workflow Execution try { - Get-BetaWorkflowExecution -BetaId $Id + Get-BetaWorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecution -BetaId $Id + # Get-BetaWorkflowExecution -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-workflow-execution-history Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution-history) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -283,16 +301,17 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execu # Get Workflow Execution History try { - Get-BetaWorkflowExecutionHistory -BetaId $Id + Get-BetaWorkflowExecutionHistory -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutionHistory -BetaId $Id + # Get-BetaWorkflowExecutionHistory -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-workflow-executions Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. @@ -306,6 +325,8 @@ Use this API to list a specified workflow's executions. Workflow executions are For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. +[API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-executions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -344,19 +365,22 @@ $Filters = 'status eq "Failed"' # String | Filter results using the standard syn # List Workflow Executions try { - Get-BetaWorkflowExecutions -BetaId $Id + Get-BetaWorkflowExecutions -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutions -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters + # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-complete-workflow-library This lists all triggers, actions, and operators in the library +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-complete-workflow-library) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -388,19 +412,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # List Complete Workflow Library try { - Get-BetaCompleteWorkflowLibrary + Get-BetaCompleteWorkflowLibrary # Below is a request that includes all optional parameters - # Get-BetaCompleteWorkflowLibrary -BetaLimit $Limit -BetaOffset $Offset + # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-workflow-library-actions This lists the workflow actions available to you. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-actions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -434,19 +461,22 @@ $Filters = 'id eq "sp:create-campaign"' # String | Filter results using the stan # List Workflow Library Actions try { - Get-BetaWorkflowLibraryActions + Get-BetaWorkflowLibraryActions # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryActions -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-workflow-library-operators This lists the workflow operators available to you +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-operators) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -474,7 +504,7 @@ Code | Description | Data Type # List Workflow Library Operators try { - Get-BetaWorkflowLibraryOperators + Get-BetaWorkflowLibraryOperators # Below is a request that includes all optional parameters # Get-BetaWorkflowLibraryOperators @@ -484,9 +514,12 @@ try { } ``` [[Back to top]](#) + ## list-workflow-library-triggers This lists the workflow triggers available to you +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflow-library-triggers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -520,19 +553,22 @@ $Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results u # List Workflow Library Triggers try { - Get-BetaWorkflowLibraryTriggers + Get-BetaWorkflowLibraryTriggers # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-workflows List all workflows in the tenant. +[API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflows) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -560,7 +596,7 @@ Code | Description | Data Type # List Workflows try { - Get-BetaWorkflows + Get-BetaWorkflows # Below is a request that includes all optional parameters # Get-BetaWorkflows @@ -570,9 +606,12 @@ try { } ``` [[Back to top]](#) + ## patch-workflow Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +[API Spec](https://developer.sailpoint.com/docs/api/beta/patch-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -610,19 +649,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaWorkflow -BetaId $Id -BetaJsonPatchOperation $Result + Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaWorkflow -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + # Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## post-external-execute-workflow This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. +[API Spec](https://developer.sailpoint.com/docs/api/beta/post-external-execute-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -654,19 +696,22 @@ $PostExternalExecuteWorkflowRequest = @""@ # Execute Workflow via External Trigger try { - Submit-BetaExternalExecuteWorkflow -BetaId $Id + Submit-BetaExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Submit-BetaExternalExecuteWorkflow -BetaId $Id -BetaPostExternalExecuteWorkflowRequest $PostExternalExecuteWorkflowRequest + # Submit-BetaExternalExecuteWorkflow -Id $Id -BetaPostExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## post-workflow-external-trigger Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. +[API Spec](https://developer.sailpoint.com/docs/api/beta/post-workflow-external-trigger) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -696,19 +741,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow # Generate External Trigger OAuth Client try { - Submit-BetaWorkflowExternalTrigger -BetaId $Id + Submit-BetaWorkflowExternalTrigger -Id $Id # Below is a request that includes all optional parameters - # Submit-BetaWorkflowExternalTrigger -BetaId $Id + # Submit-BetaWorkflowExternalTrigger -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-external-execute-workflow Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-external-execute-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -740,21 +788,24 @@ $TestExternalExecuteWorkflowRequest = @""@ # Test Workflow via External Trigger try { - Test-BetaExternalExecuteWorkflow -BetaId $Id + Test-BetaExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -BetaId $Id -BetaTestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest + # Test-BetaExternalExecuteWorkflow -Id $Id -BetaTestExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-workflow Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** +[API Spec](https://developer.sailpoint.com/docs/api/beta/test-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -787,19 +838,22 @@ $TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b, try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-BetaWorkflow -BetaId $Id -BetaTestWorkflowRequest $Result + Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Test-BetaWorkflow -BetaId $Id -BetaTestWorkflowRequest $TestWorkflowRequest + # Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-workflow Perform a full update of a workflow. The updated workflow object is returned in the response. +[API Spec](https://developer.sailpoint.com/docs/api/beta/update-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -869,10 +923,10 @@ $WorkflowBody = @"{ try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow -BetaId $Id -BetaWorkflowBody $Result + Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result # Below is a request that includes all optional parameters - # Update-BetaWorkflow -BetaId $Id -BetaWorkflowBody $WorkflowBody + # Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/index.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/index.md index f54125689..7f06009b1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/index.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/index.md @@ -11,7 +11,6 @@ tags: ['SDK', 'Software Development Kit', 'beta', 'methods'] --- Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. - ## Key Features - Purpose & Overview: Explains the purpose of the method and its role in the API. - Parameters: Describe the required input parameters, including their data types. diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md index 9d6d48011..f6a1eaaa2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index a90225ed7..5f4dae562 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md index 05cceab03..bb3b65383 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/index.md b/docs/tools/sdk/powershell/Reference/Beta/Models/index.md index 17f2caeda..d64df95f5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/index.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/index.md @@ -10,10 +10,9 @@ slug: /tools/sdk/powershell/beta/models tags: ['SDK', 'Software Development Kit', 'beta', 'models'] --- -The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. - +The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. ## Key Features - Attributes: Describe each attribute, including its name, data type, and whether it's required. - Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. -- Example: Provides a sample of how the API uses the model. +- Example: Provides a sample of how the API uses the model. \ No newline at end of file diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessModelMetadataApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessModelMetadataApi.md index 7c88d28a8..d5ad74ab3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessModelMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessModelMetadataApi.md @@ -32,9 +32,15 @@ Method | HTTP request | Description [**Get-V2024AccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes [**Get-V2024AccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values + ## get-access-model-metadata-attribute +:::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. +::: Get single Access Model Metadata Attribute +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -66,19 +72,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Access Model Metadata Attribute try { - Get-V2024AccessModelMetadataAttribute -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttribute -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-model-metadata-attribute-value +:::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. +::: Get single Access Model Metadata Attribute Value +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-model-metadata-attribute-value) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -112,19 +124,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Access Model Metadata Value try { - Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024Value $Value -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024Value $Value -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-access-model-metadata-attribute +:::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. +::: Get a list of Access Model Metadata Attributes +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -156,19 +174,25 @@ $Filters = 'name eq "Privacy"' # String | Filter results using the standard synt # List Access Model Metadata Attributes try { - Get-V2024AccessModelMetadataAttribute -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters + # Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-access-model-metadata-attribute-value +:::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. +::: Get a list of Access Model Metadata Attribute Values +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-model-metadata-attribute-value) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -200,10 +224,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # List Access Model Metadata Values try { - Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md index 33608b351..b18cda213 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md @@ -60,11 +60,14 @@ Method | HTTP request | Description [**Update-V2024AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile [**Update-V2024AccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. + ## create-access-profile Use this API to create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -179,16 +182,17 @@ $AccessProfile = @"{ try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-V2024AccessProfile -V2024AccessProfile $Result + New-V2024AccessProfile -V2024AccessProfile $Result # Below is a request that includes all optional parameters - # New-V2024AccessProfile -V2024AccessProfile $AccessProfile + # New-V2024AccessProfile -V2024AccessProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-access-profile This API deletes an existing Access Profile. @@ -196,6 +200,8 @@ The Access Profile must not be in use, for example, Access Profile can not be de A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -225,16 +231,17 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to # Delete the specified Access Profile try { - Remove-V2024AccessProfile -V2024Id $Id + Remove-V2024AccessProfile -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024AccessProfile -V2024Id $Id + # Remove-V2024AccessProfile -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-access-profiles-in-bulk This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. @@ -242,6 +249,8 @@ This endpoint can only bulk delete up to a limit of 50 access profiles per reque By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-profiles-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -276,19 +285,22 @@ $AccessProfileBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $Result + Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest + # Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-profile This API returns an Access Profile by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -318,21 +330,24 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile # Get an Access Profile try { - Get-V2024AccessProfile -V2024Id $Id + Get-V2024AccessProfile -Id $Id # Below is a request that includes all optional parameters - # Get-V2024AccessProfile -V2024Id $Id + # Get-V2024AccessProfile -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-profile-entitlements Use this API to get a list of an access profile's entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-profile-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -372,20 +387,23 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List Access Profile's Entitlements try { - Get-V2024AccessProfileEntitlements -V2024Id $Id + Get-V2024AccessProfileEntitlements -Id $Id # Below is a request that includes all optional parameters - # Get-V2024AccessProfileEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfileEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-access-profiles Use this API to get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -429,16 +447,17 @@ $IncludeUnsegmented = $false # Boolean | Indicates whether the response list sho # List Access Profiles try { - Get-V2024AccessProfiles + Get-V2024AccessProfiles # Below is a request that includes all optional parameters - # Get-V2024AccessProfiles -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented + # Get-V2024AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-access-profile This API updates an existing Access Profile. The following fields are patchable: @@ -471,6 +490,8 @@ A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -508,17 +529,21 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AccessProfile -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024AccessProfile -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024AccessProfile -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024AccessProfile -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-access-profiles-in-bulk +:::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 API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** @@ -527,6 +552,8 @@ This API initiates a bulk update of field requestable for one or more Access Pro > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-access-profiles-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -561,10 +588,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner - Update-V2024AccessProfilesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result + Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024AccessProfilesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $AccessProfileBulkUpdateRequestInner + # Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfilesInBulk" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md index cef3032b6..45e0ad2cd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md @@ -42,9 +42,12 @@ Method | HTTP request | Description [**Get-V2024PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List [**Deny-V2024AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + ## approve-access-request Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -85,19 +88,22 @@ $CommentDto = @"{ # Approve Access Request Approval try { - Approve-V2024AccessRequest -V2024ApprovalId $ApprovalId + Approve-V2024AccessRequest -ApprovalId $ApprovalId # Below is a request that includes all optional parameters - # Approve-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $CommentDto + # Approve-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024AccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## forward-access-request Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/forward-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -134,19 +140,22 @@ $ForwardApprovalDto = @"{ try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-V2024ForwardAccessRequest -V2024ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result + Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result # Below is a request that includes all optional parameters - # Invoke-V2024ForwardAccessRequest -V2024ApprovalId $ApprovalId -V2024ForwardApprovalDto $ForwardApprovalDto + # Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardAccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-approval-summary Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-approval-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -178,20 +187,23 @@ $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and tim # Get Access Requests Approvals Number try { - Get-V2024AccessRequestApprovalSummary + Get-V2024AccessRequestApprovalSummary # Below is a request that includes all optional parameters - # Get-V2024AccessRequestApprovalSummary -V2024OwnerId $OwnerId -V2024FromDate $FromDate + # Get-V2024AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovalSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-access-request-approvers This API endpoint returns the list of approvers for the given access request id. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-request-approvers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -228,19 +240,22 @@ $Count = $false # Boolean | If this is true, the *X-Total-Count* response header # Access Request Approvers try { - Get-V2024AccessRequestApprovers -V2024AccessRequestId $AccessRequestId + Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId # Below is a request that includes all optional parameters - # Get-V2024AccessRequestApprovers -V2024AccessRequestId $AccessRequestId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-completed-approvals This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-completed-approvals) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -280,19 +295,22 @@ $Sorters = "modified" # String | Sort results using the standard syntax describe # Completed Access Request Approvals List try { - Get-V2024CompletedApprovals + Get-V2024CompletedApprovals # Below is a request that includes all optional parameters - # Get-V2024CompletedApprovals -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedApprovals" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-pending-approvals This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-pending-approvals) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -300,7 +318,7 @@ 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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. - 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* + 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* Query | Sorters | **String** | (optional) | 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: **created, modified** ### Return type @@ -326,25 +344,28 @@ $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value r $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) $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) -$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) $Sorters = "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: **created, modified** (optional) # Pending Access Request Approvals List try { - Get-V2024PendingApprovals + Get-V2024PendingApprovals # Below is a request that includes all optional parameters - # Get-V2024PendingApprovals -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingApprovals" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reject-access-request Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -386,10 +407,10 @@ $CommentDto = @"{ try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $Result + Deny-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result # Below is a request that includes all optional parameters - # Deny-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $CommentDto + # Deny-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024AccessRequest" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md index 7a3636cf0..37ff66bfb 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md @@ -23,9 +23,15 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-V2024AccessRequestIdentityMetrics**](#get-access-request-identity-metrics) | **GET** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics + ## get-access-request-identity-metrics +:::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. +::: Use this API to return information access metrics. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-identity-metrics) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -61,10 +67,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Return access request identity metrics try { - Get-V2024AccessRequestIdentityMetrics -V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestIdentityMetrics -V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md index c8e871d69..86aa26927 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md @@ -42,9 +42,12 @@ Method | HTTP request | Description [**Get-V2024AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators [**Set-V2024AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration + ## approve-bulk-access-request This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights "idn:access-request-administration:write" can approve the access requests in bulk. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-bulk-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -79,20 +82,23 @@ $BulkApproveAccessRequest = @"{ try { $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest - Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $Result + Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $Result # Below is a request that includes all optional parameters - # Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $BulkApproveAccessRequest + # Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024BulkAccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## cancel-access-request This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -127,20 +133,23 @@ $CancelAccessRequest = @"{ try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-V2024AccessRequest -V2024CancelAccessRequest $Result + Suspend-V2024AccessRequest -V2024CancelAccessRequest $Result # Below is a request that includes all optional parameters - # Suspend-V2024AccessRequest -V2024CancelAccessRequest $CancelAccessRequest + # Suspend-V2024AccessRequest -V2024CancelAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## cancel-access-request-in-bulk This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. Only ORG_ADMIN or users with rights "idn:access-request-administration:write" can cancel the access requests in bulk. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-access-request-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -175,17 +184,21 @@ $BulkCancelAccessRequest = @"{ try { $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest - Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $Result + Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $Result # Below is a request that includes all optional parameters - # Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $BulkCancelAccessRequest + # Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequestInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## close-access-request +:::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 closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. @@ -199,6 +212,8 @@ To track the status of endpoint requests, navigate to Search and use this query: This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/close-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -236,16 +251,17 @@ $CloseAccessRequest = @"{ try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest - Close-V2024AccessRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result + Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result # Below is a request that includes all optional parameters - # Close-V2024AccessRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $CloseAccessRequest + # Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-access-request Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. @@ -279,6 +295,8 @@ __REVOKE_ACCESS__ * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -362,19 +380,22 @@ $AccessRequest = @"{ try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-V2024AccessRequest -V2024AccessRequest $Result + New-V2024AccessRequest -V2024AccessRequest $Result # Below is a request that includes all optional parameters - # New-V2024AccessRequest -V2024AccessRequest $AccessRequest + # New-V2024AccessRequest -V2024AccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-config This endpoint returns the current access-request configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -402,7 +423,7 @@ Code | Description | Data Type # Get Access Request Configuration try { - Get-V2024AccessRequestConfig + Get-V2024AccessRequestConfig # Below is a request that includes all optional parameters # Get-V2024AccessRequestConfig @@ -412,11 +433,14 @@ try { } ``` [[Back to top]](#) + ## list-access-request-status Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-request-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -464,20 +488,23 @@ $RequestState = "request-state=EXECUTING" # String | Filter the results by the s # Access Request Status try { - Get-V2024AccessRequestStatus + Get-V2024AccessRequestStatus # Below is a request that includes all optional parameters - # Get-V2024AccessRequestStatus -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024AssignedTo $AssignedTo -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters -V2024Sorters $Sorters -V2024RequestState $RequestState + # Get-V2024AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-administrators-access-request-status Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-administrators-access-request-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -525,19 +552,22 @@ $RequestState = "request-state=EXECUTING" # String | Filter the results by the s # Access Request Status for Administrators try { - Get-V2024AdministratorsAccessRequestStatus + Get-V2024AdministratorsAccessRequestStatus # Below is a request that includes all optional parameters - # Get-V2024AdministratorsAccessRequestStatus -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024AssignedTo $AssignedTo -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters -V2024Sorters $Sorters -V2024RequestState $RequestState + # Get-V2024AdministratorsAccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-access-request-config This endpoint replaces the current access-request configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -593,10 +623,10 @@ $AccessRequestConfig = @"{ try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-V2024AccessRequestConfig -V2024AccessRequestConfig $Result + Set-V2024AccessRequestConfig -V2024AccessRequestConfig $Result # Below is a request that includes all optional parameters - # Set-V2024AccessRequestConfig -V2024AccessRequestConfig $AccessRequestConfig + # Set-V2024AccessRequestConfig -V2024AccessRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountActivitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountActivitiesApi.md index 3caff03ce..fbba83382 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountActivitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountActivitiesApi.md @@ -53,9 +53,12 @@ Method | HTTP request | Description [**Get-V2024AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity [**Get-V2024AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities + ## get-account-activity This gets a single account activity by its id. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-activity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -86,19 +89,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id # Get an Account Activity try { - Get-V2024AccountActivity -V2024Id $Id + Get-V2024AccountActivity -Id $Id # Below is a request that includes all optional parameters - # Get-V2024AccountActivity -V2024Id $Id + # Get-V2024AccountActivity -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-account-activities This gets a collection of account activities that satisfy the given query parameters. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-account-activities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -142,10 +148,10 @@ $Sorters = "created" # String | Sort results using the standard syntax described # List Account Activities try { - Get-V2024AccountActivities + Get-V2024AccountActivities # Below is a request that includes all optional parameters - # Get-V2024AccountActivities -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivities" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountAggregationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountAggregationsApi.md index 7d2351c5d..8304a8a1f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountAggregationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountAggregationsApi.md @@ -29,7 +29,11 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-V2024AccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status + ## get-account-aggregation-status +:::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 API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. @@ -39,6 +43,8 @@ Since this endpoint reports on the status of an *in-progress* account aggregatio *Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-aggregation-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -70,10 +76,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # In-progress Account Aggregation status try { - Get-V2024AccountAggregationStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccountAggregationStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountUsagesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountUsagesApi.md index 74084068b..126c5118e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountUsagesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountUsagesApi.md @@ -22,9 +22,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-V2024UsagesByAccountId**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights + ## get-usages-by-account-id This API returns a summary of account usage insights for past 12 months. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-usages-by-account-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -62,10 +65,10 @@ $Sorters = "-date" # String | Sort results using the standard syntax described i # Returns account usage insights try { - Get-V2024UsagesByAccountId -V2024AccountId $AccountId + Get-V2024UsagesByAccountId -AccountId $AccountId # Below is a request that includes all optional parameters - # Get-V2024UsagesByAccountId -V2024AccountId $AccountId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md index e7a64f60d..399cf792d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md @@ -61,6 +61,7 @@ Method | HTTP request | Description [**Unlock-V2024Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account [**Update-V2024Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account + ## create-account Submit an account creation task - the API then returns the task ID. @@ -75,6 +76,8 @@ The endpoint doesn't actually provision the account on the target source, which By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -114,22 +117,25 @@ $AccountAttributesCreate = @"{ try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-V2024Account -V2024AccountAttributesCreate $Result + New-V2024Account -V2024AccountAttributesCreate $Result # Below is a request that includes all optional parameters - # New-V2024Account -V2024AccountAttributesCreate $AccountAttributesCreate + # New-V2024Account -V2024AccountAttributesCreate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-account Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -160,17 +166,21 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. # Delete Account try { - Remove-V2024Account -V2024Id $Id + Remove-V2024Account -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024Account -V2024Id $Id + # Remove-V2024Account -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-account-async +:::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. +::: Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: @@ -179,6 +189,8 @@ This endpoint is good for: * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-account-async) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -210,19 +222,22 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Remove Account try { - Remove-V2024AccountAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024AccountAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## disable-account This API submits a task to disable the account and returns the task ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -259,19 +274,25 @@ $AccountToggleRequest = @"{ try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $Result + Disable-V2024Account -Id $Id -V2024AccountToggleRequest $Result # Below is a request that includes all optional parameters - # Disable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest + # Disable-V2024Account -Id $Id -V2024AccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## disable-account-for-identity +:::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 API submits a task to disable IDN account for a single identity. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-account-for-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -304,19 +325,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Disable IDN Account for Identity try { - Disable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Disable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## disable-accounts-for-identities +:::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 API submits tasks to disable IDN account for each identity provided in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/disable-accounts-for-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -351,19 +378,22 @@ $IdentitiesAccountsBulkRequest = @"{ try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Disable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters - # Disable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + # Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## enable-account This API submits a task to enable account and returns the task ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -400,19 +430,25 @@ $AccountToggleRequest = @"{ try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $Result + Enable-V2024Account -Id $Id -V2024AccountToggleRequest $Result # Below is a request that includes all optional parameters - # Enable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest + # Enable-V2024Account -Id $Id -V2024AccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## enable-account-for-identity +:::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 API submits a task to enable IDN account for a single identity. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-account-for-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -445,19 +481,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Enable IDN Account for Identity try { - Enable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Enable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## enable-accounts-for-identities +:::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 API submits tasks to enable IDN account for each identity provided in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/enable-accounts-for-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -492,19 +534,22 @@ $IdentitiesAccountsBulkRequest = @"{ try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Enable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters - # Enable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + # Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-account Use this API to return the details for a single account by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -535,19 +580,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. # Account Details try { - Get-V2024Account -V2024Id $Id + Get-V2024Account -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Account -V2024Id $Id + # Get-V2024Account -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-account-entitlements This API returns entitlements of the account. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-account-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -584,19 +632,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Account Entitlements try { - Get-V2024AccountEntitlements -V2024Id $Id + Get-V2024AccountEntitlements -Id $Id # Below is a request that includes all optional parameters - # Get-V2024AccountEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-accounts List accounts. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-accounts) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -636,16 +687,17 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described # Accounts List try { - Get-V2024Accounts + Get-V2024Accounts # Below is a request that includes all optional parameters - # Get-V2024Accounts -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024DetailLevel $DetailLevel -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Accounts" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-account Use this API to update an account with a PUT request. @@ -654,6 +706,8 @@ This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -695,19 +749,22 @@ $AccountAttributes = @"{ try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-V2024Account -V2024Id $Id -V2024AccountAttributes $Result + Send-V2024Account -Id $Id -V2024AccountAttributes $Result # Below is a request that includes all optional parameters - # Send-V2024Account -V2024Id $Id -V2024AccountAttributes $AccountAttributes + # Send-V2024Account -Id $Id -V2024AccountAttributes $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-reload-account This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-reload-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -738,20 +795,23 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id # Reload Account try { - Submit-V2024ReloadAccount -V2024Id $Id + Submit-V2024ReloadAccount -Id $Id # Below is a request that includes all optional parameters - # Submit-V2024ReloadAccount -V2024Id $Id + # Submit-V2024ReloadAccount -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReloadAccount" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## unlock-account This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/unlock-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -789,16 +849,17 @@ $AccountUnlockRequest = @"{ try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-V2024Account -V2024Id $Id -V2024AccountUnlockRequest $Result + Unlock-V2024Account -Id $Id -V2024AccountUnlockRequest $Result # Below is a request that includes all optional parameters - # Unlock-V2024Account -V2024Id $Id -V2024AccountUnlockRequest $AccountUnlockRequest + # Unlock-V2024Account -Id $Id -V2024AccountUnlockRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-account Use this API to update account details. @@ -812,6 +873,8 @@ All accounts that are reassigned will be set to `manuallyCorrelated: true` unles >**Note:** The `attributes` field can only be modified for flat file accounts. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -847,10 +910,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024Account -V2024Id $Id -V2024RequestBody $Result + Update-V2024Account -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Update-V2024Account -V2024Id $Id -V2024RequestBody $RequestBody + # Update-V2024Account -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApplicationDiscoveryApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApplicationDiscoveryApi.md index fb3cf6335..dd89b7a66 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApplicationDiscoveryApi.md @@ -23,10 +23,13 @@ Method | HTTP request | Description [**Get-V2024ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery [**Send-V2024ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications + ## 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](https://developer.sailpoint.com/docs/api/v2024/get-discovered-applications) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -64,22 +67,25 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # Get Discovered Applications for Tenant try { - Get-V2024DiscoveredApplications + Get-V2024DiscoveredApplications # Below is a request that includes all optional parameters - # Get-V2024DiscoveredApplications -V2024Limit $Limit -V2024Offset $Offset -V2024Detail $Detail -V2024Filter $Filter -V2024Sorters $Sorters + # Get-V2024DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DiscoveredApplications" 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](https://developer.sailpoint.com/docs/api/v2024/get-manual-discover-applications-csv-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -107,7 +113,7 @@ Code | Description | Data Type # Download CSV Template for Discovery try { - Get-V2024ManualDiscoverApplicationsCsvTemplate + Get-V2024ManualDiscoverApplicationsCsvTemplate # Below is a request that includes all optional parameters # Get-V2024ManualDiscoverApplicationsCsvTemplate @@ -117,10 +123,13 @@ try { } ``` [[Back to top]](#) + ## send-manual-discover-applications-csv-template Uploading 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](https://developer.sailpoint.com/docs/api/v2024/send-manual-discover-applications-csv-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -150,10 +159,10 @@ $File = # System.IO.FileInfo | The CSV file to upload containing `application_n # Upload CSV to Discover Applications try { - Send-V2024ManualDiscoverApplicationsCsvTemplate -V2024File $File + Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File # Below is a request that includes all optional parameters - # Send-V2024ManualDiscoverApplicationsCsvTemplate -V2024File $File + # Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ManualDiscoverApplicationsCsvTemplate" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApprovalsApi.md index eba736fd1..0f1d322e1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApprovalsApi.md @@ -23,9 +23,15 @@ Method | HTTP request | Description [**Get-V2024Approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get an approval [**Get-V2024Approvals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals + ## get-approval +:::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. +::: Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-approval) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -57,20 +63,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get an approval try { - Get-V2024Approval -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Approval -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024Approval -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approval" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-approvals +:::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. +::: Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. Absence of all query parameters will will default to mine=true. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-approvals) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -106,10 +118,10 @@ $Filters = 'filters=status eq PENDING' # String | Filter results using the stand # Get Approvals try { - Get-V2024Approvals -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Approvals -V2024XSailPointExperimental $XSailPointExperimental -V2024Mine $Mine -V2024RequesterId $RequesterId -V2024Filters $Filters + # Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approvals" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md index ca873a9b4..9eb3cca4b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md @@ -34,9 +34,15 @@ 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 +:::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 creates a source app using the given source app payload +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -78,19 +84,25 @@ $SourceAppCreateDto = @"{ try { $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto - New-V2024SourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result + New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result # Below is a request that includes all optional parameters - # New-V2024SourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $SourceAppCreateDto + # New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-access-profiles-from-source-app-by-bulk +:::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 API returns the final list of access profiles for the specified source app after removing +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-profiles-from-source-app-by-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -129,19 +141,25 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2024AccessProfilesFromSourceAppByBulk -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + Remove-V2024AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Remove-V2024AccessProfilesFromSourceAppByBulk -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody -V2024Limit $Limit + # Remove-V2024AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -Limit $Limit } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesFromSourceAppByBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-source-app +:::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. +::: Use this API to delete a specific source app +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -173,19 +191,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Delete source app by ID try { - Remove-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-app +:::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 API returns a source app by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -218,19 +242,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get source app by ID try { - Get-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-access-profiles-for-source-app +:::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 API returns the list of access profiles for the specified source app +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-access-profiles-for-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -268,19 +298,25 @@ $Filters = 'name eq "developer access profile"' # String | Filter results using # List access profiles for the specified source app try { - Get-V2024AccessProfilesForSourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessProfilesForSourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + # Get-V2024AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfilesForSourceApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-all-source-app +:::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 API returns the list of all source apps for the org. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-all-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -320,20 +356,26 @@ $Filters = 'enabled eq true' # String | Filter results using the standard syntax # List all source apps try { - Get-V2024AllSourceApp -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AllSourceApp -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AllSourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024AllSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllSourceApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-all-user-apps +:::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 API returns the list of all user apps with specified filters. This API must be used with **filters** query parameter. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-all-user-apps) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -371,19 +413,25 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # List all user apps try { - Get-V2024AllUserApps -V2024Filters $Filters -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AllUserApps -V2024Filters $Filters -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset + # Get-V2024AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllUserApps" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-assigned-source-app +:::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 API returns the list of source apps assigned for logged in user. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-assigned-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -423,19 +471,25 @@ $Filters = 'name eq "source app name"' # String | Filter results using the stand # List assigned source apps try { - Get-V2024AssignedSourceApp -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AssignedSourceApp -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AssignedSourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024AssignedSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AssignedSourceApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-available-accounts-for-user-app +:::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 API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-available-accounts-for-user-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -471,19 +525,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List available accounts for user app try { - Get-V2024AvailableAccountsForUserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AvailableAccountsForUserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count + # Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableAccountsForUserApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-available-source-apps +:::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 API returns the list of source apps available for access request. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-available-source-apps) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -523,19 +583,25 @@ $Filters = 'name eq "source app name"' # String | Filter results using the stand # List available source apps try { - Get-V2024AvailableSourceApps -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AvailableSourceApps -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableSourceApps" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-owned-user-apps +:::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 API returns the list of user apps assigned to logged in user +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-owned-user-apps) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -573,21 +639,27 @@ $Filters = 'name eq "user app name"' # String | Filter results using the standar # List owned user apps try { - Get-V2024OwnedUserApps -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024OwnedUserApps -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Filters $Filters + # Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OwnedUserApps" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-source-app +:::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 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. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-source-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -627,20 +699,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Patch source app by ID try { - Update-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-user-app +:::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 API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **account** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-user-app) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -680,21 +758,27 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Patch user app by ID try { - Update-V2024UserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024UserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-source-apps-in-bulk +:::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 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. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-apps-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -738,10 +822,10 @@ $SourceAppBulkUpdateRequest = @"{ # Bulk update source apps try { - Update-V2024SourceAppsInBulk -V2024XSailPointExperimental $XSailPointExperimental + Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024SourceAppsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppBulkUpdateRequest $SourceAppBulkUpdateRequest + # Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -V2024SourceAppBulkUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceAppsInBulk" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md index 33d937ae5..ac6417057 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md @@ -27,9 +27,15 @@ Method | HTTP request | Description [**Get-V2024ProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles. [**Update-V2024ProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile + ## get-profile-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. +::: This API returns auth profile information. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -62,19 +68,25 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to pa # Get Auth Profile. try { - Get-V2024ProfileConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id + Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ProfileConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id + # Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-profile-config-list +:::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 API returns a list of auth profiles. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -104,20 +116,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get list of Auth Profiles. try { - Get-V2024ProfileConfigList -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ProfileConfigList -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfigList" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-profile-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. +::: This API updates an existing Auth Profile. The following fields are patchable: **offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-profile-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,10 +175,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ProfileConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ProfileConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md index 53eb418b5..24e4f2ca2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md @@ -25,9 +25,12 @@ Method | HTTP request | Description [**Get-V2024AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details [**Update-V2024AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update + ## get-auth-user Return the specified user's authentication system details. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-user) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -58,16 +61,17 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID # Auth User Details try { - Get-V2024AuthUser -V2024Id $Id + Get-V2024AuthUser -Id $Id # Below is a request that includes all optional parameters - # Get-V2024AuthUser -V2024Id $Id + # Get-V2024AuthUser -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthUser" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-auth-user Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: @@ -75,6 +79,8 @@ Use this endpoint to modify these fields: A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-user) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -113,10 +119,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AuthUser -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024AuthUser -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024AuthUser -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024AuthUser -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthUser" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024BrandingApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024BrandingApi.md index 1e5eaaec2..d04c97535 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024BrandingApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024BrandingApi.md @@ -28,9 +28,12 @@ Method | HTTP request | Description [**Get-V2024BrandingList**](#get-branding-list) | **GET** `/brandings` | List of branding items [**Set-V2024BrandingItem**](#set-branding-item) | **PUT** `/brandings/{name}` | Update a branding item + ## create-branding-item This API endpoint creates a branding item. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-branding-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -74,19 +77,22 @@ $FileStandard = # System.IO.FileInfo | png file with logo (optional) # Create a branding item try { - New-V2024BrandingItem -V2024Name $Name -V2024ProductName $ProductName + New-V2024BrandingItem -Name $Name -ProductName $ProductName # Below is a request that includes all optional parameters - # New-V2024BrandingItem -V2024Name $Name -V2024ProductName $ProductName -V2024ActionButtonColor $ActionButtonColor -V2024ActiveLinkColor $ActiveLinkColor -V2024NavigationColor $NavigationColor -V2024EmailFromAddress $EmailFromAddress -V2024LoginInformationalMessage $LoginInformationalMessage -V2024FileStandard $FileStandard + # New-V2024BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024BrandingItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-branding This API endpoint delete information for an existing branding item by name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-branding) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -117,19 +123,22 @@ $Name = "default" # String | The name of the branding item to be deleted # Delete a branding item try { - Remove-V2024Branding -V2024Name $Name + Remove-V2024Branding -Name $Name # Below is a request that includes all optional parameters - # Remove-V2024Branding -V2024Name $Name + # Remove-V2024Branding -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Branding" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-branding This API endpoint retrieves information for an existing branding item by name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-branding) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -160,19 +169,22 @@ $Name = "default" # String | The name of the branding item to be retrieved # Get a branding item try { - Get-V2024Branding -V2024Name $Name + Get-V2024Branding -Name $Name # Below is a request that includes all optional parameters - # Get-V2024Branding -V2024Name $Name + # Get-V2024Branding -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Branding" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-branding-list This API endpoint returns a list of branding items. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-branding-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -200,7 +212,7 @@ Code | Description | Data Type # List of branding items try { - Get-V2024BrandingList + Get-V2024BrandingList # Below is a request that includes all optional parameters # Get-V2024BrandingList @@ -210,9 +222,12 @@ try { } ``` [[Back to top]](#) + ## set-branding-item This API endpoint updates information for an existing branding item. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-branding-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -259,10 +274,10 @@ $FileStandard = # System.IO.FileInfo | png file with logo (optional) # Update a branding item try { - Set-V2024BrandingItem -V2024Name $Name -V2024Name2 $Name2 -V2024ProductName $ProductName + Set-V2024BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName # Below is a request that includes all optional parameters - # Set-V2024BrandingItem -V2024Name $Name -V2024Name2 $Name2 -V2024ProductName $ProductName -V2024ActionButtonColor $ActionButtonColor -V2024ActiveLinkColor $ActiveLinkColor -V2024NavigationColor $NavigationColor -V2024EmailFromAddress $EmailFromAddress -V2024LoginInformationalMessage $LoginInformationalMessage -V2024FileStandard $FileStandard + # Set-V2024BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024BrandingItem" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md index 9c83cf7a4..1957e65e9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md @@ -50,9 +50,12 @@ Method | HTTP request | Description [**Get-V2024CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters [**Update-V2024CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter + ## create-campaign-filter Use this API to create a campaign filter based on filter details and criteria. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-campaign-filter) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -100,19 +103,22 @@ $CampaignFilterDetails = @"{ try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - New-V2024CampaignFilter -V2024CampaignFilterDetails $Result + New-V2024CampaignFilter -V2024CampaignFilterDetails $Result # Below is a request that includes all optional parameters - # New-V2024CampaignFilter -V2024CampaignFilterDetails $CampaignFilterDetails + # New-V2024CampaignFilter -V2024CampaignFilterDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignFilter" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-campaign-filters Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaign-filters) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -146,19 +152,22 @@ $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filte try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2024CampaignFilters -V2024RequestBody $Result + Remove-V2024CampaignFilters -RequestBody $Result # Below is a request that includes all optional parameters - # Remove-V2024CampaignFilters -V2024RequestBody $RequestBody + # Remove-V2024CampaignFilters -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignFilters" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign-filter-by-id Retrieves information for an existing campaign filter using the filter's ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-filter-by-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -189,19 +198,22 @@ $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filte # Get Campaign Filter by ID try { - Get-V2024CampaignFilterById -V2024Id $Id + Get-V2024CampaignFilterById -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CampaignFilterById -V2024Id $Id + # Get-V2024CampaignFilterById -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilterById" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-campaign-filters Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-campaign-filters) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -235,19 +247,22 @@ $IncludeSystemFilters = $true # Boolean | If this is true, the API includes syst # List Campaign Filters try { - Get-V2024CampaignFilters + Get-V2024CampaignFilters # Below is a request that includes all optional parameters - # Get-V2024CampaignFilters -V2024Limit $Limit -V2024Start $Start -V2024IncludeSystemFilters $IncludeSystemFilters + # Get-V2024CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilters" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-campaign-filter Updates an existing campaign filter using the filter's ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-campaign-filter) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -297,10 +312,10 @@ $CampaignFilterDetails = @"{ try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - Update-V2024CampaignFilter -V2024FilterId $FilterId -V2024CampaignFilterDetails $Result + Update-V2024CampaignFilter -FilterId $FilterId -V2024CampaignFilterDetails $Result # Below is a request that includes all optional parameters - # Update-V2024CampaignFilter -V2024FilterId $FilterId -V2024CampaignFilterDetails $CampaignFilterDetails + # Update-V2024CampaignFilter -FilterId $FilterId -V2024CampaignFilterDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignFilter" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md index 3006bfa2c..b7256af86 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md @@ -105,6 +105,7 @@ Method | HTTP request | Description [**Start-V2024GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template [**Update-V2024Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign + ## complete-campaign :::caution @@ -118,6 +119,8 @@ Use this API to complete a certification campaign. This functionality is provide can complete a certification even if all items have not been completed. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -152,20 +155,23 @@ $CampaignCompleteOptions = @"{ # Complete a Campaign try { - Complete-V2024Campaign -V2024Id $Id + Complete-V2024Campaign -Id $Id # Below is a request that includes all optional parameters - # Complete-V2024Campaign -V2024Id $Id -V2024CampaignCompleteOptions $CampaignCompleteOptions + # Complete-V2024Campaign -Id $Id -V2024CampaignCompleteOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024Campaign" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-campaign Use this API to create a certification campaign with the information provided in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -304,20 +310,23 @@ $Campaign = @"{ try { $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-V2024Campaign -V2024Campaign $Result + New-V2024Campaign -V2024Campaign $Result # Below is a request that includes all optional parameters - # New-V2024Campaign -V2024Campaign $Campaign + # New-V2024Campaign -V2024Campaign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Campaign" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-campaign-template Use this API to create a certification campaign template based on campaign. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -471,20 +480,23 @@ $CampaignTemplate = @"{ try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-V2024CampaignTemplate -V2024CampaignTemplate $Result + New-V2024CampaignTemplate -V2024CampaignTemplate $Result # Below is a request that includes all optional parameters - # New-V2024CampaignTemplate -V2024CampaignTemplate $CampaignTemplate + # New-V2024CampaignTemplate -V2024CampaignTemplate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-campaign-template Use this API to delete a certification campaign template by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -515,20 +527,23 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template # Delete a Campaign Template try { - Remove-V2024CampaignTemplate -V2024Id $Id + Remove-V2024CampaignTemplate -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024CampaignTemplate -V2024Id $Id + # Remove-V2024CampaignTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-campaign-template-schedule Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaign-template-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -559,20 +574,23 @@ $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template # Delete Campaign Template Schedule try { - Remove-V2024CampaignTemplateSchedule -V2024Id $Id + Remove-V2024CampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024CampaignTemplateSchedule -V2024Id $Id + # Remove-V2024CampaignTemplateSchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplateSchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-campaigns Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-campaigns) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -606,20 +624,23 @@ $CampaignsDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest - Remove-V2024Campaigns -V2024CampaignsDeleteRequest $Result + Remove-V2024Campaigns -V2024CampaignsDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024Campaigns -V2024CampaignsDeleteRequest $CampaignsDeleteRequest + # Remove-V2024Campaigns -V2024CampaignsDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Campaigns" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-active-campaigns Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-active-campaigns) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -659,20 +680,23 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # List Campaigns try { - Get-V2024ActiveCampaigns + Get-V2024ActiveCampaigns # Below is a request that includes all optional parameters - # Get-V2024ActiveCampaigns -V2024Detail $Detail -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ActiveCampaigns" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign Use this API to get information for an existing certification campaign by the campaign's ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -705,20 +729,23 @@ $Detail = "SLIM" # String | Determines whether slim, or increased level of detai # Get Campaign try { - Get-V2024Campaign -V2024Id $Id + Get-V2024Campaign -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Campaign -V2024Id $Id -V2024Detail $Detail + # Get-V2024Campaign -Id $Id -Detail $Detail } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Campaign" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign-reports Use this API to fetch all reports for a certification campaign by campaign ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-reports) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -749,20 +776,23 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose rep # Get Campaign Reports try { - Get-V2024CampaignReports -V2024Id $Id + Get-V2024CampaignReports -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CampaignReports -V2024Id $Id + # Get-V2024CampaignReports -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReports" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign-reports-config Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-reports-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -790,7 +820,7 @@ Code | Description | Data Type # Get Campaign Reports Configuration try { - Get-V2024CampaignReportsConfig + Get-V2024CampaignReportsConfig # Below is a request that includes all optional parameters # Get-V2024CampaignReportsConfig @@ -800,10 +830,13 @@ try { } ``` [[Back to top]](#) + ## get-campaign-template Use this API to fetch a certification campaign template by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -834,20 +867,23 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template' # Get a Campaign Template try { - Get-V2024CampaignTemplate -V2024Id $Id + Get-V2024CampaignTemplate -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CampaignTemplate -V2024Id $Id + # Get-V2024CampaignTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign-template-schedule Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-template-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -878,22 +914,25 @@ $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template # Get Campaign Template Schedule try { - Get-V2024CampaignTemplateSchedule -V2024Id $Id + Get-V2024CampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CampaignTemplateSchedule -V2024Id $Id + # Get-V2024CampaignTemplateSchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplateSchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign-templates Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-campaign-templates) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -931,20 +970,23 @@ $Filters = 'name eq "manager template"' # String | Filter results using the stan # List Campaign Templates try { - Get-V2024CampaignTemplates + Get-V2024CampaignTemplates # Below is a request that includes all optional parameters - # Get-V2024CampaignTemplates -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplates" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## move This API reassigns the specified certifications from one identity to another. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/move) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -985,20 +1027,23 @@ $AdminReviewReassign = @"{ try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move-V2024 -V2024Id $Id -V2024AdminReviewReassign $Result + Move-V2024 -Id $Id -V2024AdminReviewReassign $Result # Below is a request that includes all optional parameters - # Move-V2024 -V2024Id $Id -V2024AdminReviewReassign $AdminReviewReassign + # Move-V2024 -Id $Id -V2024AdminReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2024" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-campaign-template Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1037,20 +1082,23 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024CampaignTemplate -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024CampaignTemplate -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024CampaignTemplate -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024CampaignTemplate -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-campaign-reports-config Use this API to overwrite the configuration for campaign reports. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-campaign-reports-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1083,20 +1131,23 @@ $CampaignReportsConfig = @"{ try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $Result + Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $Result # Below is a request that includes all optional parameters - # Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $CampaignReportsConfig + # Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignReportsConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-campaign-template-schedule Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-campaign-template-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1148,20 +1199,23 @@ $Schedule = @"{ # Set Campaign Template Schedule try { - Set-V2024CampaignTemplateSchedule -V2024Id $Id + Set-V2024CampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters - # Set-V2024CampaignTemplateSchedule -V2024Id $Id -V2024Schedule $Schedule + # Set-V2024CampaignTemplateSchedule -Id $Id -V2024Schedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignTemplateSchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-campaign Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1196,20 +1250,23 @@ $ActivateCampaignOptions = @"{ # Activate a Campaign try { - Start-V2024Campaign -V2024Id $Id + Start-V2024Campaign -Id $Id # Below is a request that includes all optional parameters - # Start-V2024Campaign -V2024Id $Id -V2024ActivateCampaignOptions $ActivateCampaignOptions + # Start-V2024Campaign -Id $Id -V2024ActivateCampaignOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Campaign" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-campaign-remediation-scan Use this API to run a remediation scan task for a certification campaign. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-campaign-remediation-scan) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1240,20 +1297,23 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remed # Run Campaign Remediation Scan try { - Start-V2024CampaignRemediationScan -V2024Id $Id + Start-V2024CampaignRemediationScan -Id $Id # Below is a request that includes all optional parameters - # Start-V2024CampaignRemediationScan -V2024Id $Id + # Start-V2024CampaignRemediationScan -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignRemediationScan" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-campaign-report Use this API to run a report for a certification campaign. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-campaign-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1286,16 +1346,17 @@ $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. # Run Campaign Report try { - Start-V2024CampaignReport -V2024Id $Id -V2024Type $Type + Start-V2024CampaignReport -Id $Id -Type $Type # Below is a request that includes all optional parameters - # Start-V2024CampaignReport -V2024Id $Id -V2024Type $Type + # Start-V2024CampaignReport -Id $Id -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignReport" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-generate-campaign-template Use this API to generate a new certification campaign from a campaign template. @@ -1310,6 +1371,8 @@ campaign called "Campaign for 2020" (assuming the year at generation time is 202 Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-generate-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1339,20 +1402,23 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template # Generate a Campaign from Template try { - Start-V2024GenerateCampaignTemplate -V2024Id $Id + Start-V2024GenerateCampaignTemplate -Id $Id # Below is a request that includes all optional parameters - # Start-V2024GenerateCampaignTemplate -V2024Id $Id + # Start-V2024GenerateCampaignTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024GenerateCampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-campaign Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1391,10 +1457,10 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Campaign -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024Campaign -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Campaign -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024Campaign -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationSummariesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationSummariesApi.md index 8c21330e2..93a90ea28 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationSummariesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationSummariesApi.md @@ -36,9 +36,12 @@ Method | HTTP request | Description [**Get-V2024IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification [**Get-V2024IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity + ## get-identity-access-summaries This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-access-summaries) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -81,19 +84,22 @@ $Sorters = "access.name" # String | Sort results using the standard syntax descr # Access Summaries try { - Get-V2024IdentityAccessSummaries -V2024Id $Id -V2024Type $Type + Get-V2024IdentityAccessSummaries -Id $Id -Type $Type # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessSummaries -V2024Id $Id -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-decision-summary This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-decision-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -126,19 +132,22 @@ $Filters = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | # Summary of Certification Decisions try { - Get-V2024IdentityDecisionSummary -V2024Id $Id + Get-V2024IdentityDecisionSummary -Id $Id # Below is a request that includes all optional parameters - # Get-V2024IdentityDecisionSummary -V2024Id $Id -V2024Filters $Filters + # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-summaries This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-summaries) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -179,19 +188,22 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # Identity Summaries for Campaign Certification try { - Get-V2024IdentitySummaries -V2024Id $Id + Get-V2024IdentitySummaries -Id $Id # Below is a request that includes all optional parameters - # Get-V2024IdentitySummaries -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-summary This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -224,10 +236,10 @@ $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity # Summary for Identity try { - Get-V2024IdentitySummary -V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId + Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId # Below is a request that includes all optional parameters - # Get-V2024IdentitySummary -V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId + # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md index 2fa086b50..94c012c65 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md @@ -52,9 +52,12 @@ Method | HTTP request | Description [**Invoke-V2024SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions [**Submit-V2024ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + ## get-certification-task This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-certification-task) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -85,19 +88,22 @@ $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID # Certification Task by ID try { - Get-V2024CertificationTask -V2024Id $Id + Get-V2024CertificationTask -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CertificationTask -V2024Id $Id + # Get-V2024CertificationTask -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationTask" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-certification This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-certification) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -128,19 +134,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id # Identity Certification by ID try { - Get-V2024IdentityCertification -V2024Id $Id + Get-V2024IdentityCertification -Id $Id # Below is a request that includes all optional parameters - # Get-V2024IdentityCertification -V2024Id $Id + # Get-V2024IdentityCertification -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertification" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-certification-item-permissions This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-certification-item-permissions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -181,19 +190,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Permissions for Entitlement Certification Item try { - Get-V2024IdentityCertificationItemPermissions -V2024CertificationId $CertificationId -V2024ItemId $ItemId + Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId # Below is a request that includes all optional parameters - # Get-V2024IdentityCertificationItemPermissions -V2024CertificationId $CertificationId -V2024ItemId $ItemId -V2024Filters $Filters -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertificationItemPermissions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-pending-certification-tasks This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-certification-tasks) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -232,19 +244,22 @@ $Filters = 'type eq "ADMIN_REASSIGN"' # String | Filter results using the standa # List of Pending Certification Tasks try { - Get-V2024PendingCertificationTasks + Get-V2024PendingCertificationTasks # Below is a request that includes all optional parameters - # Get-V2024PendingCertificationTasks -V2024ReviewerIdentity $ReviewerIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + # Get-V2024PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingCertificationTasks" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-certification-reviewers This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-certification-reviewers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -285,19 +300,22 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # List of Reviewers for certification try { - Get-V2024CertificationReviewers -V2024Id $Id + Get-V2024CertificationReviewers -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CertificationReviewers -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationReviewers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-access-review-items This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-access-review-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -344,19 +362,22 @@ $Roles = "userRole" # String | Filter results to view access review items that p # List of Access Review Items try { - Get-V2024IdentityAccessReviewItems -V2024Id $Id + Get-V2024IdentityAccessReviewItems -Id $Id # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessReviewItems -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024Entitlements $Entitlements -V2024AccessProfiles $AccessProfiles -V2024Roles $Roles + # Get-V2024IdentityAccessReviewItems -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -Entitlements $Entitlements -AccessProfiles $AccessProfiles -Roles $Roles } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessReviewItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-certifications Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-certifications) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -396,19 +417,22 @@ $Sorters = "name,due" # String | Sort results using the standard syntax describe # List Identity Campaign Certifications try { - Get-V2024IdentityCertifications + Get-V2024IdentityCertifications # Below is a request that includes all optional parameters - # Get-V2024IdentityCertifications -V2024ReviewerIdentity $ReviewerIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertifications" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## make-identity-decision The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/make-identity-decision) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -454,19 +478,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campa try { $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision - Select-V2024IdentityDecision -V2024Id $Id -V2024ReviewDecision $Result + Select-V2024IdentityDecision -Id $Id -V2024ReviewDecision $Result # Below is a request that includes all optional parameters - # Select-V2024IdentityDecision -V2024Id $Id -V2024ReviewDecision $ReviewDecision + # Select-V2024IdentityDecision -Id $Id -V2024ReviewDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2024IdentityDecision" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reassign-identity-certifications This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reassign-identity-certifications) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -510,19 +537,22 @@ $ReviewReassign = @"{ try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Invoke-V2024ReassignIdentityCertifications -V2024Id $Id -V2024ReviewReassign $Result + Invoke-V2024ReassignIdentityCertifications -Id $Id -V2024ReviewReassign $Result # Below is a request that includes all optional parameters - # Invoke-V2024ReassignIdentityCertifications -V2024Id $Id -V2024ReviewReassign $ReviewReassign + # Invoke-V2024ReassignIdentityCertifications -Id $Id -V2024ReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ReassignIdentityCertifications" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## sign-off-identity-certification This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/sign-off-identity-certification) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -553,16 +583,17 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certif # Finalize Identity Certification Decisions try { - Invoke-V2024SignOffIdentityCertification -V2024Id $Id + Invoke-V2024SignOffIdentityCertification -Id $Id # Below is a request that includes all optional parameters - # Invoke-V2024SignOffIdentityCertification -V2024Id $Id + # Invoke-V2024SignOffIdentityCertification -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024SignOffIdentityCertification" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-reassign-certs-async This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the @@ -571,6 +602,8 @@ reassignment is complete. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-reassign-certs-async) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -614,10 +647,10 @@ $ReviewReassign = @"{ try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-V2024ReassignCertsAsync -V2024Id $Id -V2024ReviewReassign $Result + Submit-V2024ReassignCertsAsync -Id $Id -V2024ReviewReassign $Result # Below is a request that includes all optional parameters - # Submit-V2024ReassignCertsAsync -V2024Id $Id -V2024ReviewReassign $ReviewReassign + # Submit-V2024ReassignCertsAsync -Id $Id -V2024ReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md index 91c83d25f..69ae7b6ee 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md @@ -45,9 +45,12 @@ Method | HTTP request | Description [**Get-V2024UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations [**Update-V2024ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings + ## create-deploy This API performs a deploy based on an existing daft. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-deploy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -80,22 +83,25 @@ $DeployRequest = @"{ try { $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest - New-V2024Deploy -V2024DeployRequest $Result + New-V2024Deploy -V2024DeployRequest $Result # Below is a request that includes all optional parameters - # New-V2024Deploy -V2024DeployRequest $DeployRequest + # New-V2024Deploy -V2024DeployRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-object-mapping This creates an object mapping between current org and source org. Source org should be "default" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-object-mapping) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -135,22 +141,25 @@ $ObjectMappingRequest = @"{ try { $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest - New-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result + New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result # Below is a request that includes all optional parameters - # New-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $ObjectMappingRequest + # New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-object-mappings This creates a set of object mappings (Max 25) between current org and source org. Source org should be "default" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-object-mappings) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -198,16 +207,17 @@ $ObjectMappingBulkCreateRequest = @"{ try { $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest - New-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result + New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result # Below is a request that includes all optional parameters - # New-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest + # New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-uploaded-configuration This API uploads a JSON configuration file into a tenant. @@ -215,6 +225,8 @@ Configuration files can be managed and deployed via Configuration Hub by uploadi Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-uploaded-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -246,16 +258,17 @@ $Name = "MyName" # String | Name that will be assigned to the uploaded configura # Upload a Configuration try { - New-V2024UploadedConfiguration -V2024Data $Data -V2024Name $Name + New-V2024UploadedConfiguration -Data $Data -Name $Name # Below is a request that includes all optional parameters - # New-V2024UploadedConfiguration -V2024Data $Data -V2024Name $Name + # New-V2024UploadedConfiguration -Data $Data -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024UploadedConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-backup This API deletes an existing backup for the current tenant. @@ -263,6 +276,8 @@ On success, this endpoint will return an empty response. The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-backup) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -293,16 +308,17 @@ $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to # Delete a Backup try { - Remove-V2024Backup -V2024Id $Id + Remove-V2024Backup -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024Backup -V2024Id $Id + # Remove-V2024Backup -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Backup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-draft This API deletes an existing draft for the current tenant. @@ -310,6 +326,8 @@ On success, this endpoint will return an empty response. The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-draft) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -340,22 +358,25 @@ $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to d # Delete a draft try { - Remove-V2024Draft -V2024Id $Id + Remove-V2024Draft -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024Draft -V2024Id $Id + # Remove-V2024Draft -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Draft" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-object-mapping This deletes an existing object mapping. Source org should be "default" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-object-mapping) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -388,16 +409,17 @@ $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of t # Deletes an object mapping try { - Remove-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId + Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId # Below is a request that includes all optional parameters - # Remove-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId + # Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-uploaded-configuration This API deletes an uploaded configuration based on Id. @@ -405,6 +427,8 @@ On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-uploaded-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -435,19 +459,22 @@ $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded c # Delete an Uploaded Configuration try { - Remove-V2024UploadedConfiguration -V2024Id $Id + Remove-V2024UploadedConfiguration -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024UploadedConfiguration -V2024Id $Id + # Remove-V2024UploadedConfiguration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024UploadedConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-deploy This API gets an existing deploy for the current tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-deploy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -478,22 +505,25 @@ $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. # Get a Deploy try { - Get-V2024Deploy -V2024Id $Id + Get-V2024Deploy -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Deploy -V2024Id $Id + # Get-V2024Deploy -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-object-mappings This gets a list of existing object mappings between current org and source org. Source org should be "default" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-object-mappings) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -524,19 +554,22 @@ $SourceOrg = "source-org" # String | The name of the source org. # Gets list of object mappings try { - Get-V2024ObjectMappings -V2024SourceOrg $SourceOrg + Get-V2024ObjectMappings -SourceOrg $SourceOrg # Below is a request that includes all optional parameters - # Get-V2024ObjectMappings -V2024SourceOrg $SourceOrg + # Get-V2024ObjectMappings -SourceOrg $SourceOrg } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ObjectMappings" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-uploaded-configuration This API gets an existing uploaded configuration for the current tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-uploaded-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -567,19 +600,22 @@ $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded c # Get an Uploaded Configuration try { - Get-V2024UploadedConfiguration -V2024Id $Id + Get-V2024UploadedConfiguration -Id $Id # Below is a request that includes all optional parameters - # Get-V2024UploadedConfiguration -V2024Id $Id + # Get-V2024UploadedConfiguration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-backups This API gets a list of existing backups for the current tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-backups) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -609,19 +645,22 @@ $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard s # List Backups try { - Get-V2024Backups + Get-V2024Backups # Below is a request that includes all optional parameters - # Get-V2024Backups -V2024Filters $Filters + # Get-V2024Backups -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Backups" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-deploys This API gets a list of deploys for the current tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-deploys) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -649,7 +688,7 @@ Code | Description | Data Type # List Deploys try { - Get-V2024Deploys + Get-V2024Deploys # Below is a request that includes all optional parameters # Get-V2024Deploys @@ -659,9 +698,12 @@ try { } ``` [[Back to top]](#) + ## list-drafts This API gets a list of existing drafts for the current tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-drafts) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -691,19 +733,22 @@ $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard s # List Drafts try { - Get-V2024Drafts + Get-V2024Drafts # Below is a request that includes all optional parameters - # Get-V2024Drafts -V2024Filters $Filters + # Get-V2024Drafts -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-uploaded-configurations This API gets a list of existing uploaded configurations for the current tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-uploaded-configurations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -734,22 +779,25 @@ $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard s # List Uploaded Configurations try { - Get-V2024UploadedConfigurations + Get-V2024UploadedConfigurations # Below is a request that includes all optional parameters - # Get-V2024UploadedConfigurations -V2024Filters $Filters + # Get-V2024UploadedConfigurations -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfigurations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-object-mappings This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be "default" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-object-mappings) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -796,10 +844,10 @@ $ObjectMappingBulkPatchRequest = @"{ try { $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest - Update-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result + Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result # Below is a request that includes all optional parameters - # Update-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest + # Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md index 13d0f9b8f..e19cb940e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md @@ -31,9 +31,15 @@ Method | HTTP request | Description [**Send-V2024ConnectorRule**](#put-connector-rule) | **PUT** `/connector-rules/{id}` | Update Connector Rule [**Test-V2024ConnectorRule**](#test-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule + ## create-connector-rule +:::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. +::: Create a connector rule from the available types. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-connector-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -91,19 +97,25 @@ $ConnectorRuleCreateRequest = @"{ try { $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest - New-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result + New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result # Below is a request that includes all optional parameters - # New-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $ConnectorRuleCreateRequest + # New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorRule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-connector-rule +:::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. +::: Delete the connector rule for the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-connector-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -136,19 +148,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Delete Connector Rule try { - Remove-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorRule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-connector-rule +:::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. +::: Get a connector rule by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -181,19 +199,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Connector Rule try { - Get-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-connector-rule-list +:::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. +::: List existing connector rules. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-rule-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -229,19 +253,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List Connector Rules try { - Get-V2024ConnectorRuleList -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024ConnectorRuleList -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ConnectorRuleList -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024ConnectorRuleList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRuleList" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-connector-rule +:::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. +::: Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -302,19 +332,25 @@ $ConnectorRuleUpdateRequest = @"{ # Update Connector Rule try { - Send-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Send-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest + # Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorRule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-connector-rule +:::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. +::: Detect issues within the connector rule's code to fix and list them. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-connector-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -350,10 +386,10 @@ $SourceCode = @"{ try { $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode - Test-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result + Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result # Below is a request that includes all optional parameters - # Test-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceCode $SourceCode + # Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectorRule" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md index 07b64e709..800be00b1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md @@ -45,9 +45,12 @@ Method | HTTP request | Description [**Send-V2024ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations [**Update-V2024Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name + ## create-custom-connector Create custom connector. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-connector) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -85,19 +88,22 @@ $V3CreateConnectorDto = @"{ try { $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto - New-V2024CustomConnector -V2024V3CreateConnectorDto $Result + New-V2024CustomConnector -V2024V3CreateConnectorDto $Result # Below is a request that includes all optional parameters - # New-V2024CustomConnector -V2024V3CreateConnectorDto $V3CreateConnectorDto + # New-V2024CustomConnector -V2024V3CreateConnectorDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-custom-connector Delete a custom connector that using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-custom-connector) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -128,19 +134,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc # Delete Connector by Script Name try { - Remove-V2024CustomConnector -V2024ScriptName $ScriptName + Remove-V2024CustomConnector -ScriptName $ScriptName # Below is a request that includes all optional parameters - # Remove-V2024CustomConnector -V2024ScriptName $ScriptName + # Remove-V2024CustomConnector -ScriptName $ScriptName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomConnector" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-connector Fetches a connector that using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -173,19 +182,22 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale # Get Connector by Script Name try { - Get-V2024Connector -V2024ScriptName $ScriptName + Get-V2024Connector -ScriptName $ScriptName # Below is a request that includes all optional parameters - # Get-V2024Connector -V2024ScriptName $ScriptName -V2024Locale $Locale + # Get-V2024Connector -ScriptName $ScriptName -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connector" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-connector-correlation-config Fetches a connector's correlation config using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-correlation-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -216,19 +228,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc # Get Connector Correlation Configuration try { - Get-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName + Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName # Below is a request that includes all optional parameters - # Get-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName + # Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCorrelationConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-connector-list Fetches list of connectors that have 'RELEASED' status using filtering and pagination. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -267,19 +282,22 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale # Get Connector List try { - Get-V2024ConnectorList + Get-V2024ConnectorList # Below is a request that includes all optional parameters - # Get-V2024ConnectorList -V2024Filters $Filters -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Locale $Locale + # Get-V2024ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorList" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-connector-source-config Fetches a connector's source config using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -310,19 +328,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc # Get Connector Source Configuration try { - Get-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName + Get-V2024ConnectorSourceConfig -ScriptName $ScriptName # Below is a request that includes all optional parameters - # Get-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName + # Get-V2024ConnectorSourceConfig -ScriptName $ScriptName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-connector-source-template Fetches a connector's source template using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-source-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -353,19 +374,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc # Get Connector Source Template try { - Get-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName + Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName # Below is a request that includes all optional parameters - # Get-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName + # Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-connector-translations Fetches a connector's translations using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-connector-translations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -398,19 +422,22 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale # Get Connector Translations try { - Get-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale + Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale # Below is a request that includes all optional parameters - # Get-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale + # Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorTranslations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-connector-correlation-config Update a connector's correlation config using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-correlation-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -443,19 +470,22 @@ $File = # System.IO.FileInfo | connector correlation config xml file # Update Connector Correlation Configuration try { - Send-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName -V2024File $File + Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File # Below is a request that includes all optional parameters - # Send-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName -V2024File $File + # Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCorrelationConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-connector-source-config Update a connector's source config using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -488,19 +518,22 @@ $File = # System.IO.FileInfo | connector source config xml file # Update Connector Source Configuration try { - Send-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName -V2024File $File + Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File # Below is a request that includes all optional parameters - # Send-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName -V2024File $File + # Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-connector-source-template Update a connector's source template using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-source-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -533,19 +566,22 @@ $File = # System.IO.FileInfo | connector source template xml file # Update Connector Source Template try { - Send-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName -V2024File $File + Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File # Below is a request that includes all optional parameters - # Send-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName -V2024File $File + # Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-connector-translations Update a connector's translations using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-connector-translations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -578,16 +614,17 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale # Update Connector Translations try { - Send-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale + Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale # Below is a request that includes all optional parameters - # Send-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale + # Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorTranslations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-connector This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. @@ -603,6 +640,8 @@ The following fields are patchable: * sourceConfigXml +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-connector) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -641,10 +680,10 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Connector -V2024ScriptName $ScriptName -V2024JsonPatchOperation $Result + Update-V2024Connector -ScriptName $ScriptName -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Connector -V2024ScriptName $ScriptName -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024Connector -ScriptName $ScriptName -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Connector" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md index 6393283f2..9e82457a8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md @@ -44,8 +44,14 @@ Method | HTTP request | Description [**Search-V2024PreDefinedSelectOptions**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options. [**Show-V2024PreviewDataSource**](#show-preview-data-source) | **POST** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source. -## create-form-definition +## create-form-definition +:::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. +::: + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition) ### Parameters Param Type | Name | Data Type | Required | Description @@ -188,18 +194,24 @@ $Body = @"{ # Creates a form definition. try { - New-V2024FormDefinition -V2024XSailPointExperimental $XSailPointExperimental + New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024FormDefinition -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + # New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -V2024Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) -## create-form-definition-dynamic-schema +## create-form-definition-dynamic-schema +:::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. +::: + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-dynamic-schema) ### Parameters Param Type | Name | Data Type | Required | Description @@ -241,19 +253,25 @@ $Body = @"{ # Generate JSON Schema dynamically. try { - New-V2024FormDefinitionDynamicSchema -V2024XSailPointExperimental $XSailPointExperimental + New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024FormDefinitionDynamicSchema -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + # New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -V2024Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-form-definition-file-request +:::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. +::: Parameter `{formDefinitionID}` should match a form definition ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-definition-file-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -291,18 +309,24 @@ $File = # System.IO.FileInfo | File specifying the multipart # Upload new form definition file. try { - New-V2024FormDefinitionFileRequest -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File + New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File # Below is a request that includes all optional parameters - # New-V2024FormDefinitionFileRequest -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File + # New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) -## create-form-instance +## create-form-instance +:::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. +::: + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-form-instance) ### Parameters Param Type | Name | Data Type | Required | Description @@ -355,19 +379,25 @@ $Body = @"{ # Creates a form instance. try { - New-V2024FormInstance -V2024XSailPointExperimental $XSailPointExperimental + New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024FormInstance -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + # New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -V2024Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-form-definition +:::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. +::: Parameter `{formDefinitionID}` should match a form definition ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-form-definition) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -400,19 +430,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Deletes a form definition. try { - Remove-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-form-definitions-by-tenant +:::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. +::: No parameters required. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-form-definitions-by-tenant) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -450,18 +486,24 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # List form definitions by tenant. try { - Export-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental + Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Export-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters + # Export-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) -## get-file-from-s3 +## get-file-from-s3 +:::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. +::: + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-file-from-s3) ### Parameters Param Type | Name | Data Type | Required | Description @@ -498,19 +540,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Download definition file by fileId. try { - Get-V2024FileFromS3 -V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024FileFromS3 -V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-form-definition-by-key +:::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. +::: Parameter `{formDefinitionID}` should match a form definition ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-definition-by-key) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -543,19 +591,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Return a form definition. try { - Get-V2024FormDefinitionByKey -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024FormDefinitionByKey -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-form-instance-by-key +:::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. +::: Parameter `{formInstanceID}` should match a form instance ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-by-key) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -588,18 +642,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Returns a form instance. try { - Get-V2024FormInstanceByKey -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024FormInstanceByKey -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) -## get-form-instance-file +## get-form-instance-file +:::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. +::: + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-form-instance-file) ### Parameters Param Type | Name | Data Type | Required | Description @@ -636,18 +696,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Download instance file by fileId. try { - Get-V2024FormInstanceFile -V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024FormInstanceFile -V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) -## import-form-definitions +## import-form-definitions +:::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. +::: + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-form-definitions) ### Parameters Param Type | Name | Data Type | Required | Description @@ -687,19 +753,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Import form definitions from export. try { - Import-V2024FormDefinitions -V2024XSailPointExperimental $XSailPointExperimental + Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Import-V2024FormDefinitions -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + # Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -V2024Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-form-definition +:::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. +::: Parameter `{formDefinitionID}` should match a form definition ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-definition) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -736,19 +808,25 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for # Patch a form definition. try { - Update-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + # Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-form-instance +:::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. +::: Parameter `{formInstanceID}` should match a form instance ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-form-instance) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -786,19 +864,25 @@ $Body = @{ key_example = } # Map[] | Body is the request payload to patch a for # Patch a form instance. try { - Update-V2024FormInstance -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental + Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024FormInstance -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + # Update-V2024FormInstance -FormInstanceID $FormInstanceID -XSailPointExperimental $XSailPointExperimental -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-form-definitions-by-tenant +:::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. +::: No parameters required. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-definitions-by-tenant) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -836,20 +920,26 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # Export form definitions by tenant. try { - Search-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental + Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Search-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters + # Search-V2024FormDefinitionsByTenant -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-form-element-data-by-element-id +:::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. +::: Parameter `{formInstanceID}` should match a form instance ID. Parameter `{formElementID}` should match a form element ID at the data source configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-element-data-by-element-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -890,19 +980,25 @@ $Query = "support" # String | String that is passed to the underlying API to fil # Retrieves dynamic data by element. try { - Search-V2024FormElementDataByElementID -V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental + Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Search-V2024FormElementDataByElementID -V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query + # Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-form-instances-by-tenant +:::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. +::: No parameters required. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-form-instances-by-tenant) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -932,19 +1028,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # List form instances by tenant. try { - Search-V2024FormInstancesByTenant -V2024XSailPointExperimental $XSailPointExperimental + Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Search-V2024FormInstancesByTenant -V2024XSailPointExperimental $XSailPointExperimental + # Search-V2024FormInstancesByTenant -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-pre-defined-select-options +:::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. +::: No parameters required. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-pre-defined-select-options) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -974,18 +1076,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # List predefined select options. try { - Search-V2024PreDefinedSelectOptions -V2024XSailPointExperimental $XSailPointExperimental + Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Search-V2024PreDefinedSelectOptions -V2024XSailPointExperimental $XSailPointExperimental + # Search-V2024PreDefinedSelectOptions -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) -## show-preview-data-source +## show-preview-data-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. +::: + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/show-preview-data-source) ### Parameters Param Type | Name | Data Type | Required | Description @@ -1037,10 +1145,10 @@ $FormElementPreviewRequest = @"{ # Preview form definition data source. try { - Show-V2024PreviewDataSource -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Show-V2024PreviewDataSource -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query -V2024FormElementPreviewRequest $FormElementPreviewRequest + # Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -V2024FormElementPreviewRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md index 446c27fda..fe68516d7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md @@ -32,9 +32,15 @@ Method | HTTP request | Description [**Remove-V2024CustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID [**Get-V2024CustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID + ## create-custom-password-instructions +:::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 API creates the custom password instructions for the specified page ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-custom-password-instructions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -69,19 +75,25 @@ $CustomPasswordInstruction = @"{ try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction - New-V2024CustomPasswordInstructions -V2024XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result + New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result # Below is a request that includes all optional parameters - # New-V2024CustomPasswordInstructions -V2024XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $CustomPasswordInstruction + # New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomPasswordInstructions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-custom-password-instructions +:::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 API delete the custom password instructions for the specified page ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-custom-password-instructions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -114,19 +126,25 @@ $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 # Delete Custom Password Instructions by page ID try { - Remove-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale + # Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomPasswordInstructions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-custom-password-instructions +:::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 API returns the custom password instructions for the specified page ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-custom-password-instructions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -159,10 +177,10 @@ $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 # Get Custom Password Instructions by Page ID try { - Get-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale + # Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md index 994ff285f..2bb788cae 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md @@ -28,10 +28,13 @@ Method | HTTP request | Description [**Update-V2024DataSegment**](#patch-data-segment) | **PATCH** `/data-segments/{segmentId}` | Update Segment [**Publish-V2024DataSegment**](#publish-data-segment) | **POST** `/data-segments/{segmentId}` | Publish segment by ID + ## create-data-segment This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-data-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -62,19 +65,25 @@ $DataSegment = @""@ try { $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment - New-V2024DataSegment -V2024DataSegment $Result + New-V2024DataSegment -V2024DataSegment $Result # Below is a request that includes all optional parameters - # New-V2024DataSegment -V2024DataSegment $DataSegment + # New-V2024DataSegment -V2024DataSegment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DataSegment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-data-segment +:::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 API deletes the segment specified by the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-data-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -109,19 +118,25 @@ $Published = $false # Boolean | This determines which version of the segment to # Delete Segment by ID try { - Remove-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Published $Published + # Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -Published $Published } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024DataSegment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-data-segment +:::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 API returns the segment specified by the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -154,19 +169,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Segment by ID try { - Get-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-data-segment-identity-membership +:::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 API returns the segment membership specified by the given identity ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segment-identity-membership) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -199,19 +220,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get SegmentMembership by Identity ID try { - Get-V2024DataSegmentIdentityMembership -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024DataSegmentIdentityMembership -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentIdentityMembership" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-data-segmentation-enabled-for-user +:::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 API returns whether or not segmentation is enabled for the identity. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-data-segmentation-enabled-for-user) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -244,19 +271,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Is Segmentation enabled by Identity try { - Get-V2024DataSegmentationEnabledForUser -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024DataSegmentationEnabledForUser -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentationEnabledForUser" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-data-segments +:::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 API returns the segment specified by the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-data-segments) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -301,19 +334,25 @@ $Filters = 'name eq ""' # String | Filter results using the standard syntax desc # Get Segments try { - Get-V2024DataSegments -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024DataSegments -V2024XSailPointExperimental $XSailPointExperimental -V2024Enabled $Enabled -V2024Unique $Unique -V2024Published $Published -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + # Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental -Enabled $Enabled -Unique $Unique -Published $Published -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegments" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-data-segment +:::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. +::: Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-data-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -351,19 +390,25 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + Update-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Update-V2024DataSegment -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody + # Update-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024DataSegment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## publish-data-segment +:::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 will publish the segment so that it starts applying the segmentation to the desired users if enabled +[API Spec](https://developer.sailpoint.com/docs/api/v2024/publish-data-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -401,10 +446,10 @@ $PublishAll = $true # Boolean | This flag decides whether you want to publish al try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Publish-V2024DataSegment -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Publish-V2024DataSegment -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody -V2024PublishAll $PublishAll + # Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -PublishAll $PublishAll } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2024DataSegment" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md index ff9ecdb20..523d51283 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md @@ -27,12 +27,15 @@ Method | HTTP request | Description [**Get-V2024Dimensions**](#list-dimensions) | **GET** `/roles/{roleId}/dimensions` | List Dimensions [**Update-V2024Dimension**](#patch-dimension) | **PATCH** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified Dimension + ## create-dimension This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-dimension) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -151,22 +154,25 @@ $Dimension = @"{ try { $Result = ConvertFrom-JsonToDimension -Json $Dimension - New-V2024Dimension -V2024RoleId $RoleId -V2024Dimension $Result + New-V2024Dimension -RoleId $RoleId -V2024Dimension $Result # Below is a request that includes all optional parameters - # New-V2024Dimension -V2024RoleId $RoleId -V2024Dimension $Dimension + # New-V2024Dimension -RoleId $RoleId -V2024Dimension $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Dimension" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-bulk-dimensions This endpoint initiates a bulk deletion of one or more dimensions. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-bulk-dimensions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -201,20 +207,23 @@ $DimensionBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest - Remove-V2024BulkDimensions -V2024RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result + Remove-V2024BulkDimensions -RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024BulkDimensions -V2024RoleId $RoleId -V2024DimensionBulkDeleteRequest $DimensionBulkDeleteRequest + # Remove-V2024BulkDimensions -RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkDimensions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-dimension This API deletes a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-dimension) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -246,21 +255,24 @@ $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension # Delete a Dimension try { - Remove-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId + Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId # Below is a request that includes all optional parameters - # Remove-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId + # Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Dimension" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-dimension This API returns a Dimension by its ID. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-dimension) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -292,21 +304,24 @@ $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension # Get a Dimension under Role. try { - Get-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId + Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId # Below is a request that includes all optional parameters - # Get-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId + # Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimension" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-dimension-entitlements This API lists the Entitlements associated with a given dimension. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-dimension-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -348,21 +363,24 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List Dimension's Entitlements try { - Get-V2024DimensionEntitlements -V2024RoleId $RoleId -V2024DimensionId $DimensionId + Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId # Below is a request that includes all optional parameters - # Get-V2024DimensionEntitlements -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-dimension-access-profiles This API lists the Access Profiles associated with a given Dimension A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-dimension-access-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -405,21 +423,24 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List Dimension's Access Profiles try { - Get-V2024DimensionAccessProfiles -V2024RoleId $RoleId -V2024DimensionId $DimensionId + Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId # Below is a request that includes all optional parameters - # Get-V2024DimensionAccessProfiles -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionAccessProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-dimensions This API returns a list of dimensions under a specified role. A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-dimensions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -461,16 +482,17 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List Dimensions try { - Get-V2024Dimensions -V2024RoleId $RoleId + Get-V2024Dimensions -RoleId $RoleId # Below is a request that includes all optional parameters - # Get-V2024Dimensions -V2024RoleId $RoleId -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024Dimensions -RoleId $RoleId -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimensions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-dimension This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** @@ -478,6 +500,8 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required The maximum supported length for the description field is 2000 characters. When you use this API to modify a dimension's membership identities, you can only modify up to a limit of 500 membership identities at a time. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-dimension) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -517,10 +541,10 @@ $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024JsonPatchOperation $Result + Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Dimension" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md index 751d9c8e8..c16812452 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md @@ -79,9 +79,15 @@ Method | HTTP request | Description [**Reset-V2024SourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset Source Entitlements [**Update-V2024EntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list + ## create-access-model-metadata-for-entitlement +:::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. +::: Add single Access Model Metadata to an entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-model-metadata-for-entitlement) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -117,19 +123,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Add metadata to an entitlement. try { - New-V2024AccessModelMetadataForEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024AccessModelMetadataForEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + # New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-access-model-metadata-from-entitlement +:::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. +::: Remove single Access Model Metadata from an entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-access-model-metadata-from-entitlement) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -165,19 +177,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Remove metadata from an entitlement. try { - Remove-V2024AccessModelMetadataFromEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024AccessModelMetadataFromEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-entitlement +:::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 API returns an entitlement by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -210,19 +228,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get an entitlement try { - Get-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-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. +::: This API returns the entitlement request config for a specified entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -255,23 +279,32 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Entitlement Request Config try { - Get-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-entitlements-by-source +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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. +::: Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-entitlements-by-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -305,19 +338,25 @@ $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlemen # Aggregate Entitlements try { - Import-V2024EntitlementsBySource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Import-V2024EntitlementsBySource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CsvFile $CsvFile + # Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $CsvFile } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-entitlement-children +:::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 API returns a list of all child entitlements of a given entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-children) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -360,19 +399,25 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar # List of entitlements children try { - Get-V2024EntitlementChildren -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementChildren -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-entitlement-parents +:::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 API returns a list of all parent entitlements of a given entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlement-parents) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -415,23 +460,29 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar # List of entitlements parents try { - Get-V2024EntitlementParents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementParents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-entitlements +:::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 API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -479,23 +530,29 @@ $Filters = 'attribute eq "memberOf"' # String | Filter results using the standar # Gets a list of entitlements. try { - Get-V2024Entitlements -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Entitlements -V2024XSailPointExperimental $XSailPointExperimental -V2024AccountId $AccountId -V2024SegmentedForIdentity $SegmentedForIdentity -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-entitlement +:::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 API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-entitlement) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -535,19 +592,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Patch an entitlement try { - Update-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-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. +::: This API replaces the entitlement request config for a specified entitlement. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-entitlement-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -595,20 +658,26 @@ $EntitlementRequestConfig = @"{ try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig - Send-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result + Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result # Below is a request that includes all optional parameters - # Send-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $EntitlementRequestConfig + # Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reset-source-entitlements +:::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. +::: Remove all entitlements from a specific source. To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reset-source-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -640,17 +709,21 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Reset Source Entitlements try { - Reset-V2024SourceEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Reset-V2024SourceEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-entitlements-in-bulk +:::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 API applies an update to every entitlement of the list.\n\nThe\ \ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\ \ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\ @@ -659,6 +732,8 @@ try { : boolean }**`" +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-entitlements-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -702,10 +777,10 @@ $EntitlementBulkUpdateRequest = @"{ try { $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest - Update-V2024EntitlementsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result + Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result # Below is a request that includes all optional parameters - # Update-V2024EntitlementsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $EntitlementBulkUpdateRequest + # Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md index 73cfdf091..f12f771ed 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md @@ -24,9 +24,12 @@ Method | HTTP request | Description [**Get-V2024AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. [**Update-V2024AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. + ## create-auth-org-network-config This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-auth-org-network-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -62,19 +65,22 @@ $NetworkConfiguration = @"{ try { $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration - New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $Result + New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $Result # Below is a request that includes all optional parameters - # New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $NetworkConfiguration + # New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-auth-org-network-config This API returns the details of an org's network auth configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-network-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -103,7 +109,7 @@ Code | Description | Data Type # Get security network configuration. try { - Get-V2024AuthOrgNetworkConfig + Get-V2024AuthOrgNetworkConfig # Below is a request that includes all optional parameters # Get-V2024AuthOrgNetworkConfig @@ -113,10 +119,13 @@ try { } ``` [[Back to top]](#) + ## patch-auth-org-network-config This API updates an existing network configuration for an org using PATCH Requires security scope of: 'sp:auth-org:manage' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-network-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -153,10 +162,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $Result + Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md index 2a9c37233..50dab89b3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md @@ -33,9 +33,15 @@ Method | HTTP request | Description [**Update-V2024Workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group [**Update-V2024WorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group + ## create-workgroup +:::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 API creates a new Governance Group. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workgroup) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -83,19 +89,25 @@ $WorkgroupDto = @"{ try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto - New-V2024Workgroup -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result + New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result # Below is a request that includes all optional parameters - # New-V2024Workgroup -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $WorkgroupDto + # New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-workgroup +:::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 API deletes a Governance Group by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -127,22 +139,28 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Delete a Governance Group try { - Remove-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workgroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-workgroup-members +:::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 API removes one or more members from a Governance Group. A > **Following field of Identity is an optional field in the request.** > **name** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroup-members) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -178,17 +196,21 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Remove-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result # Below is a request that includes all optional parameters - # Remove-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity + # Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-workgroups-in-bulk +:::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 API initiates a bulk deletion of one or more Governance Groups. @@ -202,6 +224,8 @@ This API initiates a bulk deletion of one or more Governance Groups. > **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workgroups-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -236,19 +260,25 @@ $WorkgroupBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest - Remove-V2024WorkgroupsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result + Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024WorkgroupsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest + # Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-workgroup +:::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 API returns a Governance Groups by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workgroup) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -280,19 +310,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Governance Group by Id try { - Get-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-connections +:::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 API returns list of connections associated with a Governance Group. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-connections) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -332,19 +368,25 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List connections for Governance Group try { - Get-V2024Connections -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Connections -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters + # Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connections" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-workgroup-members +:::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 API returns list of members associated with a Governance Group. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroup-members) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -384,19 +426,25 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List Governance Group Members try { - Get-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters + # Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkgroupMembers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-workgroups +:::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 API returns list of Governance Groups +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workgroups) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -436,22 +484,28 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List Governance Groups try { - Get-V2024Workgroups -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Workgroups -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroups" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-workgroup +:::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 API updates an existing governance group by ID. The following fields and objects are patchable: * name * description * owner +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-workgroup) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -490,23 +544,29 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Patch a Governance Group try { - Update-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-workgroup-members +:::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 API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. > **Following field of Identity is an optional field in the request.** > **name** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-workgroup-members) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -542,10 +602,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Update-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result # Below is a request that includes all optional parameters - # Update-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity + # Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md index d4e373de0..f8bab79cf 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md @@ -26,9 +26,15 @@ Method | HTTP request | Description [**Get-V2024AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations [**Get-V2024AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations + ## add-access-request-recommendations-ignored-item +:::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 API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-ignored-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -67,19 +73,25 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsIgnoredItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsIgnoredItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + # Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## add-access-request-recommendations-requested-item +:::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 API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-requested-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -118,19 +130,25 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsRequestedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsRequestedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + # Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## add-access-request-recommendations-viewed-item +:::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 API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-viewed-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -169,19 +187,25 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsViewedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsViewedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + # Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## add-access-request-recommendations-viewed-items +:::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 API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/add-access-request-recommendations-viewed-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -221,19 +245,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + # Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-recommendations +:::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 API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -277,19 +307,25 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ # Identity Access Request Recommendations try { - Get-V2024AccessRequestRecommendations -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityId $IdentityId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024IncludeTranslationMessages $IncludeTranslationMessages -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-recommendations-ignored-items +:::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 API returns the list of ignored access request recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-ignored-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -329,19 +365,25 @@ $Sorters = "access.id" # String | Sort results using the standard syntax describ # List of Ignored Access Request Recommendations try { - Get-V2024AccessRequestRecommendationsIgnoredItems -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsIgnoredItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsIgnoredItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-recommendations-requested-items +:::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 API returns a list of requested access request recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-requested-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -381,19 +423,25 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ # List of Requested Access Request Recommendations try { - Get-V2024AccessRequestRecommendationsRequestedItems -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsRequestedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsRequestedItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-recommendations-viewed-items +:::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 API returns the list of viewed access request recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-viewed-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -433,10 +481,10 @@ $Sorters = "MySorters" # String | Sort results using the standard syntax describ # List of Viewed Access Request Recommendations try { - Get-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAICommonAccessApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAICommonAccessApi.md index e663dc979..5a3b9fedd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAICommonAccessApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAICommonAccessApi.md @@ -21,9 +21,15 @@ Method | HTTP request | Description [**Get-V2024CommonAccess**](#get-common-access) | **GET** `/common-access` | Get a paginated list of common access [**Update-V2024CommonAccessStatusInBulk**](#update-common-access-status-in-bulk) | **POST** `/common-access/update-status` | Bulk update common access status + ## create-common-access +:::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 API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-common-access) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -66,19 +72,25 @@ $CommonAccessItemRequest = @"{ try { $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest - New-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result + New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result # Below is a request that includes all optional parameters - # New-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $CommonAccessItemRequest + # New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-common-access +:::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 returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-common-access) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -117,19 +129,25 @@ $Sorters = "access.name" # String | Sort results using the standard syntax descr # Get a paginated list of common access try { - Get-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CommonAccess" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-common-access-status-in-bulk +:::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 submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-common-access-status-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -166,10 +184,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus - Update-V2024CommonAccessStatusInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result + Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result # Below is a request that includes all optional parameters - # Update-V2024CommonAccessStatusInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $CommonAccessIDStatus + # Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CommonAccessStatusInBulk" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIOutliersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIOutliersApi.md index f7f6bdf86..cd37ba2f3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIOutliersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIOutliersApi.md @@ -27,12 +27,18 @@ Method | HTTP request | Description [**Get-V2024OutliersContributingFeatureAccessItems**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature [**Invoke-V2024UnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore + ## export-outliers-zip +:::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 API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-outliers-zip) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -64,19 +70,25 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi # IAI Identity Outliers Export try { - Export-V2024OutliersZip -V2024XSailPointExperimental $XSailPointExperimental + Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Export-V2024OutliersZip -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type + # Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024OutliersZip" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-outlier-snapshots +:::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 API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-outlier-snapshots) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -117,19 +129,25 @@ $Sorters = "snapshotDate" # String | Sort results using the standard syntax desc # IAI Identity Outliers Summary try { - Get-V2024IdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Type $Type -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutlierSnapshots" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-outliers +:::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 API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-outliers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -171,19 +189,25 @@ $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort re # IAI Get Identity Outliers try { - Get-V2024IdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Type $Type -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutliers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-latest-identity-outlier-snapshots +:::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 API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-latest-identity-outlier-snapshots) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -216,22 +240,28 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi # IAI Identity Outliers Latest Summary try { - Get-V2024LatestIdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024LatestIdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type + # Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LatestIdentityOutlierSnapshots" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-outlier-contributing-feature-summary +:::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 API returns a summary of a contributing feature for an identity outlier. The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-outlier-contributing-feature-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -264,22 +294,28 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get identity outlier contibuting feature summary try { - Get-V2024OutlierContributingFeatureSummary -V2024OutlierFeatureId $OutlierFeatureId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024OutlierContributingFeatureSummary -V2024OutlierFeatureId $OutlierFeatureId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutlierContributingFeatureSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-peer-group-outliers-contributing-features +:::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 API returns a list of contributing feature objects for a single outlier. The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-peer-group-outliers-contributing-features) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -322,19 +358,25 @@ $Sorters = "importance" # String | Sort results using the standard syntax descri # Get identity outlier's contibuting features try { - Get-V2024PeerGroupOutliersContributingFeatures -V2024OutlierId $OutlierId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PeerGroupOutliersContributingFeatures -V2024OutlierId $OutlierId -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024IncludeTranslationMessages $IncludeTranslationMessages -V2024Sorters $Sorters + # Get-V2024PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliersContributingFeatures" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## ignore-identity-outliers +:::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 API receives a list of identity IDs in the request, changes the outliers to be ignored. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/ignore-identity-outliers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -369,22 +411,28 @@ $RequestBody = "MyRequestBody" # String[] | try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2024IgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Invoke-V2024IgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody + # Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024IgnoreIdentityOutliers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-outliers-contributing-feature-access-items +:::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 API returns a list of the enriched access items associated with each feature filtered by the access item type. The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-outliers-contributing-feature-access-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -429,19 +477,25 @@ $Sorters = "displayName" # String | Sort results using the standard syntax descr # Gets a list of access items associated with each identity outlier contributing feature try { - Get-V2024OutliersContributingFeatureAccessItems -V2024OutlierId $OutlierId -V2024ContributingFeatureName $ContributingFeatureName -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024OutliersContributingFeatureAccessItems -V2024OutlierId $OutlierId -V2024ContributingFeatureName $ContributingFeatureName -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024AccessType $AccessType -V2024Sorters $Sorters + # Get-V2024OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutliersContributingFeatureAccessItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## un-ignore-identity-outliers +:::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 API receives a list of identity IDs in the request, changes the outliers to be un-ignored. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/un-ignore-identity-outliers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -476,10 +530,10 @@ $RequestBody = "MyRequestBody" # String[] | try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-V2024UnIgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result # Below is a request that includes all optional parameters - # Invoke-V2024UnIgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody + # Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnIgnoreIdentityOutliers" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIPeerGroupStrategiesApi.md index d14280489..87f764821 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIPeerGroupStrategiesApi.md @@ -19,9 +19,18 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-V2024PeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List + ## get-peer-group-outliers +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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. +::: -- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-peer-group-outliers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -59,10 +68,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Identity Outliers List try { - Get-V2024PeerGroupOutliers -V2024Strategy $Strategy -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PeerGroupOutliers -V2024Strategy $Strategy -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliers" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md index 5e982c077..72bf34b43 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md @@ -21,9 +21,15 @@ Method | HTTP request | Description [**Get-V2024RecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values [**Update-V2024RecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values + ## get-recommendations +:::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. +::: The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-recommendations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -74,19 +80,25 @@ $RecommendationRequestDto = @"{ try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto - Get-V2024Recommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result + Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result # Below is a request that includes all optional parameters - # Get-V2024Recommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $RecommendationRequestDto + # Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-recommendations-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. +::: Retrieves configuration attributes used by certification recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-recommendations-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -115,19 +127,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get certification recommendation config values try { - Get-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RecommendationsConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-recommendations-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. +::: Updates configuration attributes used by certification recommendations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-recommendations-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -164,10 +182,10 @@ $RecommendationConfigDto = @"{ try { $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto - Update-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result + Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result # Below is a request that includes all optional parameters - # Update-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $RecommendationConfigDto + # Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RecommendationsConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRoleMiningApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRoleMiningApi.md index 5c199e77d..04b552360 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRoleMiningApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRoleMiningApi.md @@ -43,9 +43,15 @@ Method | HTTP request | Description [**Update-V2024RoleMiningSession**](#patch-role-mining-session) | **PATCH** `/role-mining-sessions/{sessionId}` | Patch a role mining session [**Update-V2024EntitlementsPotentialRole**](#update-entitlements-potential-role) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements + ## create-potential-role-provision-request +:::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 method starts a job to provision a potential role +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-potential-role-provision-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -91,19 +97,25 @@ $RoleMiningPotentialRoleProvisionRequest = @"{ # Create request to provision a potential role into an actual role. try { - New-V2024PotentialRoleProvisionRequest -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024PotentialRoleProvisionRequest -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024MinEntitlementPopularity $MinEntitlementPopularity -V2024IncludeCommonAccess $IncludeCommonAccess -V2024RoleMiningPotentialRoleProvisionRequest $RoleMiningPotentialRoleProvisionRequest + # New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -V2024RoleMiningPotentialRoleProvisionRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-role-mining-sessions +:::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 submits a create role mining session request to the role mining application. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role-mining-sessions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -167,19 +179,25 @@ $RoleMiningSessionDto = @"{ try { $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto - New-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result + New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result # Below is a request that includes all optional parameters - # New-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $RoleMiningSessionDto + # New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## download-role-mining-potential-role-zip +:::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 downloads a completed export of information for a potential role in a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/download-role-mining-potential-role-zip) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -214,19 +232,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Export (download) details for a potential role in a role mining session try { - Invoke-V2024DownloadRoleMiningPotentialRoleZip -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + Invoke-V2024DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Invoke-V2024DownloadRoleMiningPotentialRoleZip -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + # Invoke-V2024DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleMiningPotentialRoleZip" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-role-mining-potential-role +:::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 downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -259,19 +283,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Export (download) details for a potential role in a role mining session try { - Export-V2024RoleMiningPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Export-V2024RoleMiningPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + # Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-role-mining-potential-role-async +:::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 uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role-async) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -309,19 +339,25 @@ $RoleMiningPotentialRoleExportRequest = @"{ # Asynchronously export details for a potential role in a role mining session and upload to S3 try { - Export-V2024RoleMiningPotentialRoleAsync -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Export-V2024RoleMiningPotentialRoleAsync -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleExportRequest $RoleMiningPotentialRoleExportRequest + # Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleExportRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-role-mining-potential-role-status +:::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 retrieves information about the current status of a potential role export. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-role-mining-potential-role-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -356,19 +392,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Retrieve status of a potential role export job try { - Export-V2024RoleMiningPotentialRoleStatus -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + Export-V2024RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Export-V2024RoleMiningPotentialRoleStatus -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + # Export-V2024RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-all-potential-role-summaries +:::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. +::: Returns all potential role summaries that match the query parameters +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-all-potential-role-summaries) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -408,19 +450,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves all potential role summaries try { - Get-V2024AllPotentialRoleSummaries -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AllPotentialRoleSummaries -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllPotentialRoleSummaries" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-entitlement-distribution-potential-role +:::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 method returns entitlement popularity distribution for a potential role in a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-distribution-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -455,19 +503,25 @@ $IncludeCommonAccess = $true # Boolean | Boolean determining whether common acce # Retrieves entitlement popularity distribution for a potential role in a role mining session try { - Get-V2024EntitlementDistributionPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementDistributionPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeCommonAccess $IncludeCommonAccess + # Get-V2024EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDistributionPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-entitlements-potential-role +:::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 method returns entitlements for a potential role in a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlements-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -513,19 +567,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves entitlements for a potential role in a role mining session try { - Get-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeCommonAccess $IncludeCommonAccess -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-excluded-entitlements-potential-role +:::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 method returns excluded entitlements for a potential role in a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-excluded-entitlements-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -568,19 +628,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves excluded entitlements for a potential role in a role mining session try { - Get-V2024ExcludedEntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ExcludedEntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ExcludedEntitlementsPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identities-potential-role +:::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 method returns identities for a potential role in a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identities-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -623,19 +689,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves identities for a potential role in a role mining session try { - Get-V2024IdentitiesPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentitiesPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitiesPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-potential-role +:::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 method returns a specific potential role for a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -669,19 +741,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Retrieves a specific potential role try { - Get-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-potential-role-applications +:::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 method returns the applications of a potential role for a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-applications) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -723,19 +801,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves the applications of a potential role for a role mining session try { - Get-V2024PotentialRoleApplications -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleApplications -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleApplications" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-potential-role-entitlements +:::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 method returns the entitlements of a potential role for a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -777,19 +861,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves the entitlements of a potential role for a role mining session try { - Get-V2024PotentialRoleEntitlements -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleEntitlements -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-potential-role-source-identity-usage +:::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 method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-source-identity-usage) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -831,19 +921,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves potential role source usage try { - Get-V2024PotentialRoleSourceIdentityUsage -V2024PotentialRoleId $PotentialRoleId -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleSourceIdentityUsage -V2024PotentialRoleId $PotentialRoleId -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSourceIdentityUsage" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-potential-role-summaries +:::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 method returns the potential role summaries for a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-potential-role-summaries) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -885,19 +981,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves all potential role summaries try { - Get-V2024PotentialRoleSummaries -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PotentialRoleSummaries -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSummaries" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-mining-potential-role +:::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 method returns a specific potential role. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -929,19 +1031,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Retrieves a specific potential role try { - Get-V2024RoleMiningPotentialRole -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleMiningPotentialRole -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningPotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-mining-session +:::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. +::: The method retrieves a role mining session. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-session) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -974,19 +1082,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get a role mining session try { - Get-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSession" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-mining-session-status +:::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 method returns a role mining session status for a customer. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-session-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1017,19 +1131,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get role mining session status state try { - Get-V2024RoleMiningSessionStatus -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleMiningSessionStatus -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessionStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-mining-sessions +:::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. +::: Returns all role mining sessions that match the query parameters +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-mining-sessions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1069,19 +1189,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves all role mining sessions try { - Get-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-saved-potential-roles +:::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 method returns all saved potential roles (draft roles). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-saved-potential-roles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1119,17 +1245,21 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieves all saved potential roles try { - Get-V2024SavedPotentialRoles -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SavedPotentialRoles -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedPotentialRoles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-potential-role +:::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. +::: The method updates an existing potential role using. The following fields can be modified: @@ -1144,6 +1274,8 @@ The following fields can be modified: >**NOTE: All other fields cannot be modified.** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1182,17 +1314,21 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + # Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-potential-role-0 +:::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. +::: The method updates an existing potential role using. The following fields can be modified: @@ -1207,6 +1343,8 @@ The following fields can be modified: >**NOTE: All other fields cannot be modified.** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-potential-role-0) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1245,19 +1383,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2024PotentialRole0 -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024PotentialRole0 -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + # Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-role-mining-session +:::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. +::: The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-role-mining-session) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1298,19 +1442,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-entitlements-potential-role +:::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 adds or removes entitlements from an exclusion list for a potential role. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-entitlements-potential-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1349,10 +1499,10 @@ $RoleMiningPotentialRoleEditEntitlements = @"{ try { $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements - Update-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result + Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result # Below is a request that includes all optional parameters - # Update-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $RoleMiningPotentialRoleEditEntitlements + # Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsPotentialRole" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IconsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IconsApi.md index b2d3aa28b..fc77a9e77 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IconsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IconsApi.md @@ -22,9 +22,15 @@ Method | HTTP request | Description [**Remove-V2024Icon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon [**Set-V2024Icon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon + ## delete-icon +:::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 API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-icon) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -59,19 +65,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Delete an icon try { - Remove-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Icon" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-icon +:::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 API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-icon) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -108,10 +120,10 @@ $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png' # Update an icon try { - Set-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image + Set-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image # Below is a request that includes all optional parameters - # Set-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image + # Set-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Icon" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md index 67c33dfe5..949450bc7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md @@ -44,9 +44,15 @@ Method | HTTP request | Description [**Start-V2024IdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds [**Sync-V2024hronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. + ## delete-identity +:::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. +::: The API returns successful response if the requested identity was deleted. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -79,19 +85,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Delete identity try { - Remove-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Identity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity +:::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 API returns a single identity using the Identity ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -124,21 +136,27 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Identity Details try { - Get-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-ownership-details +:::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. +::: Use this API to return an identity's owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-ownership-details) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -171,18 +189,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get ownership details try { - Get-V2024IdentityOwnershipDetails -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityOwnershipDetails -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOwnershipDetails" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) -## get-role-assignment +## get-role-assignment +:::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. +::: + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assignment) ### Parameters Param Type | Name | Data Type | Required | Description @@ -218,19 +242,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Role assignment details try { - Get-V2024RoleAssignment -V2024IdentityId $IdentityId -V2024AssignmentId $AssignmentId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleAssignment -V2024IdentityId $IdentityId -V2024AssignmentId $AssignmentId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-assignments +:::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 returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assignments) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -267,19 +297,25 @@ $RoleName = "Engineer" # String | Role name to filter the role assignments with # List role assignments try { - Get-V2024RoleAssignments -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleAssignments -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleId $RoleId -V2024RoleName $RoleName + # Get-V2024RoleAssignments -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -RoleId $RoleId -RoleName $RoleName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identities +:::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 API returns a list of identities. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -321,19 +357,25 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # List Identities try { - Get-V2024Identities -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Identities -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Identities -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Sorters $Sorters -V2024DefaultFilter $DefaultFilter -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset + # Get-V2024Identities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reset-identity +:::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. +::: Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reset-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -366,20 +408,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Reset an identity try { - Reset-V2024Identity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Reset-V2024Identity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + # Reset-V2024Identity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024Identity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-identity-verification-account-token +:::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 API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-identity-verification-account-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -418,17 +466,21 @@ $SendAccountVerificationRequest = @"{ try { $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest - Send-V2024IdentityVerificationAccountToken -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id -V2024SendAccountVerificationRequest $Result + Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -V2024SendAccountVerificationRequest $Result # Below is a request that includes all optional parameters - # Send-V2024IdentityVerificationAccountToken -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id -V2024SendAccountVerificationRequest $SendAccountVerificationRequest + # Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -V2024SendAccountVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-identities-invite +:::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 API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. This task will send an invitation email only for unregistered identities. @@ -436,6 +488,8 @@ This task will send an invitation email only for unregistered identities. The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-identities-invite) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -472,17 +526,21 @@ $InviteIdentitiesRequest = @"{ try { $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest - Start-V2024IdentitiesInvite -V2024XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result + Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result # Below is a request that includes all optional parameters - # Start-V2024IdentitiesInvite -V2024XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $InviteIdentitiesRequest + # Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-identity-processing +:::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 operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. This endpoint will perform the following tasks: @@ -492,6 +550,8 @@ This endpoint will perform the following tasks: 4. Recalculate manager relationships. 5. Potentially clean-up identity processing errors, assuming the error has been resolved. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-identity-processing) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -527,19 +587,25 @@ $ProcessIdentitiesRequest = @"{ try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest - Start-V2024IdentityProcessing -V2024XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result + Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result # Below is a request that includes all optional parameters - # Start-V2024IdentityProcessing -V2024XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $ProcessIdentitiesRequest + # Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## synchronize-attributes-for-identity +:::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 end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/synchronize-attributes-for-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -572,10 +638,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Attribute synchronization for single identity. try { - Sync-V2024hronizeAttributesForIdentity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Sync-V2024hronizeAttributesForIdentity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + # Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024hronizeAttributesForIdentity" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md index 88d8e8684..4eca840bb 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md @@ -24,9 +24,15 @@ Method | HTTP request | Description [**Get-V2024IdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes [**Send-V2024IdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute + ## create-identity-attribute +:::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. +::: Use this API to create a new identity attribute. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -81,19 +87,25 @@ $IdentityAttribute = @"{ try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - New-V2024IdentityAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result # Below is a request that includes all optional parameters - # New-V2024IdentityAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute + # New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-identity-attribute +:::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 deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -126,19 +138,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Delete Identity Attribute try { - Remove-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-identity-attributes-in-bulk +:::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. +::: Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attributes-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -174,19 +192,25 @@ $IdentityAttributeNames = @"{ try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames - Remove-V2024IdentityAttributesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result + Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result # Below is a request that includes all optional parameters - # Remove-V2024IdentityAttributesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $IdentityAttributeNames + # Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-attribute +:::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 gets an identity attribute for a given technical name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -219,19 +243,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Identity Attribute try { - Get-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-attributes +:::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. +::: Use this API to get a collection of identity attributes. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -269,19 +299,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List Identity Attributes try { - Get-V2024IdentityAttributes -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeSystem $IncludeSystem -V2024IncludeSilent $IncludeSilent -V2024SearchableOnly $SearchableOnly -V2024Count $Count + # Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-identity-attribute +:::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 updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-identity-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -338,10 +374,10 @@ $IdentityAttribute = @"{ try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - Send-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result # Below is a request that includes all optional parameters - # Send-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute + # Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md index f550156f8..01f6b1367 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md @@ -29,9 +29,15 @@ Method | HTTP request | Description [**Get-V2024IdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type [**Get-V2024IdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity + ## compare-identity-snapshots +:::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 method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/compare-identity-snapshots) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -77,19 +83,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Gets a difference of count for each access item types for the given identity between 2 snapshots try { - Compare-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Compare-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Compare-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Snapshot1 $Snapshot1 -V2024Snapshot2 $Snapshot2 -V2024AccessItemTypes $AccessItemTypes -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Compare-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshots" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## compare-identity-snapshots-access-type +:::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 method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/compare-identity-snapshots-access-type) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -135,19 +147,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Gets a list of differences of specific accessType for the given identity between 2 snapshots try { - Compare-V2024IdentitySnapshotsAccessType -V2024Id $Id -V2024AccessType $AccessType -V2024XSailPointExperimental $XSailPointExperimental + Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Compare-V2024IdentitySnapshotsAccessType -V2024Id $Id -V2024AccessType $AccessType -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessAssociated $AccessAssociated -V2024Snapshot1 $Snapshot1 -V2024Snapshot2 $Snapshot2 -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshotsAccessType" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-historical-identity +:::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 method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-historical-identity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -179,19 +197,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get latest snapshot of identity try { - Get-V2024HistoricalIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024HistoricalIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentity" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-historical-identity-events +:::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 method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-historical-identity-events) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -240,19 +264,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Lists all events for the given identity try { - Get-V2024HistoricalIdentityEvents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024HistoricalIdentityEvents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024From $From -V2024EventTypes $EventTypes -V2024AccessItemTypes $AccessItemTypes -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentityEvents" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-snapshot +:::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 method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-snapshot) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -286,19 +316,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Gets an identity snapshot at a given date try { - Get-V2024IdentitySnapshot -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshot -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshot" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-snapshot-summary +:::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 method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-snapshot-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -342,19 +378,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Gets the summary for the event count for a specific identity try { - Get-V2024IdentitySnapshotSummary -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshotSummary -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Before $Before -V2024Interval $Interval -V2024TimeZone $TimeZone -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-start-date +:::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 method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-start-date) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -386,19 +428,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Gets the start date of the identity try { - Get-V2024IdentityStartDate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityStartDate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityStartDate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-historical-identities +:::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 gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-historical-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -438,20 +486,26 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # Lists all the identities try { - Get-V2024HistoricalIdentities -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024HistoricalIdentities -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024HistoricalIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024StartsWithQuery $StartsWithQuery -V2024IsDeleted $IsDeleted -V2024IsActive $IsActive -V2024Limit $Limit -V2024Offset $Offset + # Get-V2024HistoricalIdentities -XSailPointExperimental $XSailPointExperimental -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-access-items +:::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 method retrieves a list of access item for the identity filtered by the access item type +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-access-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -492,19 +546,25 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # List Access Items by Identity try { - Get-V2024IdentityAccessItems -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessItems -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset + # Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental -Type $Type -Limit $Limit -Count $Count -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-snapshot-access-items +:::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 method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-snapshot-access-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -540,19 +600,25 @@ $Type = "account" # String | The access item type (optional) # Gets the list of identity access items at a given date filterd by item type try { - Get-V2024IdentitySnapshotAccessItems -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshotAccessItems -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type + # Get-V2024IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotAccessItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-snapshots +:::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 method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-snapshots) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -594,10 +660,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Lists all the snapshots for the identity try { - Get-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Start $Start -V2024Interval $Interval -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshots" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md index c7c25c4a7..dd1803fd5 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md @@ -39,9 +39,12 @@ Method | HTTP request | Description [**Sync-V2024IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile [**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile + ## create-identity-profile This creates an Identity Profile. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -120,16 +123,17 @@ $IdentityProfile = @"{ try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-V2024IdentityProfile -V2024IdentityProfile $Result + New-V2024IdentityProfile -V2024IdentityProfile $Result # Below is a request that includes all optional parameters - # New-V2024IdentityProfile -V2024IdentityProfile $IdentityProfile + # New-V2024IdentityProfile -V2024IdentityProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-identity-profile This deletes an Identity Profile based on ID. @@ -138,6 +142,8 @@ On success, this endpoint will return a reference to the bulk delete task result The following rights are required to access this endpoint: idn:identity-profile:delete +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -168,16 +174,17 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity # Delete an Identity Profile try { - Remove-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters - # Remove-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + # Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-identity-profiles This deletes multiple Identity Profiles via a list of supplied IDs. @@ -185,6 +192,8 @@ On success, this endpoint will return a reference to the bulk delete task result The following rights are required to access this endpoint: idn:identity-profile:delete +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -217,19 +226,22 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-V2024IdentityProfiles -V2024RequestBody $Result + Remove-V2024IdentityProfiles -RequestBody $Result # Below is a request that includes all optional parameters - # Remove-V2024IdentityProfiles -V2024RequestBody $RequestBody + # Remove-V2024IdentityProfiles -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-identity-profiles This exports existing identity profiles in the format specified by the sp-config service. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -267,19 +279,22 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described # Export Identity Profiles try { - Export-V2024IdentityProfiles + Export-V2024IdentityProfiles # Below is a request that includes all optional parameters - # Export-V2024IdentityProfiles -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Export-V2024IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024IdentityProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-default-identity-attribute-config This returns the default identity attribute config. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-default-identity-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -310,19 +325,22 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Ident # Get default Identity Attribute Config try { - Get-V2024DefaultIdentityAttributeConfig -V2024IdentityProfileId $IdentityProfileId + Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters - # Get-V2024DefaultIdentityAttributeConfig -V2024IdentityProfileId $IdentityProfileId + # Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultIdentityAttributeConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-identity-profile This returns a single Identity Profile based on ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -353,19 +371,22 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Ident # Get single Identity Profile try { - Get-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters - # Get-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + # Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-identity-profiles This imports previously exported identity profiles. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -458,19 +479,22 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $Result + Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $Result # Below is a request that includes all optional parameters - # Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $IdentityProfileExportedObject + # Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024IdentityProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-profiles This returns a list of Identity Profiles based on the specified query parameters. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -508,20 +532,23 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described # Identity Profiles List try { - Get-V2024IdentityProfiles + Get-V2024IdentityProfiles # Below is a request that includes all optional parameters - # Get-V2024IdentityProfiles -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## show-identity-preview Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/show-identity-preview) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -578,16 +605,17 @@ $IdentityPreviewRequest = @"{ try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - Show-V2024IdentityPreview -V2024IdentityPreviewRequest $Result + Show-V2024IdentityPreview -V2024IdentityPreviewRequest $Result # Below is a request that includes all optional parameters - # Show-V2024IdentityPreview -V2024IdentityPreviewRequest $IdentityPreviewRequest + # Show-V2024IdentityPreview -V2024IdentityPreviewRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024IdentityPreview" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## sync-identity-profile Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. @@ -595,6 +623,8 @@ This should only be run on identity profiles that have the `identityRefreshRequi This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/sync-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -625,16 +655,17 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity # Process identities under profile try { - Sync-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + Sync-V2024IdentityProfile -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters - # Sync-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + # Sync-V2024IdentityProfile -IdentityProfileId $IdentityProfileId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024IdentityProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-identity-profile This updates the specified Identity Profile. @@ -648,6 +679,8 @@ Some fields of the Schema cannot be updated. These fields are listed below: * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -686,10 +719,10 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result + Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024IdentityProfile" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md index eb1fc3e5a..949de1c07 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md @@ -62,9 +62,12 @@ Method | HTTP request | Description [**Set-V2024LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State [**Update-V2024LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + ## create-lifecycle-state Use this endpoint to create a lifecycle state. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-lifecycle-state) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -121,19 +124,22 @@ $LifecycleState = @"{ try { $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState - New-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result + New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result # Below is a request that includes all optional parameters - # New-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleState $LifecycleState + # New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024LifecycleState" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-lifecycle-state Use this endpoint to delete the lifecycle state by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-lifecycle-state) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -166,19 +172,22 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat # Delete Lifecycle State try { - Remove-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId # Below is a request that includes all optional parameters - # Remove-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + # Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024LifecycleState" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-lifecycle-state Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-lifecycle-state) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -211,19 +220,22 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat # Get Lifecycle State try { - Get-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId # Below is a request that includes all optional parameters - # Get-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + # Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleState" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-lifecycle-states Use this endpoint to list all lifecycle states by their associated identity profiles. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-lifecycle-states) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -261,19 +273,22 @@ $Sorters = "created,modified" # String | Sort results using the standard syntax # Lists LifecycleStates try { - Get-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId + Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId # Below is a request that includes all optional parameters - # Get-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + # Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleStates" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-lifecycle-state Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-lifecycle-state) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -307,19 +322,22 @@ $SetLifecycleStateRequest = @""@ try { $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest - Set-V2024LifecycleState -V2024IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result + Set-V2024LifecycleState -IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result # Below is a request that includes all optional parameters - # Set-V2024LifecycleState -V2024IdentityId $IdentityId -V2024SetLifecycleStateRequest $SetLifecycleStateRequest + # Set-V2024LifecycleState -IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024LifecycleState" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-lifecycle-states Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-lifecycle-states) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -360,10 +378,10 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result + Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md index 743951ddf..680d2a34a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md @@ -25,9 +25,12 @@ Method | HTTP request | Description [**Set-V2024MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration [**Test-V2024MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration + ## get-mfa-duo-config This API returns the configuration of an Duo MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-duo-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -55,7 +58,7 @@ Code | Description | Data Type # Configuration of Duo MFA method try { - Get-V2024MFADuoConfig + Get-V2024MFADuoConfig # Below is a request that includes all optional parameters # Get-V2024MFADuoConfig @@ -65,9 +68,12 @@ try { } ``` [[Back to top]](#) + ## get-mfa-kba-config This API returns the KBA configuration for MFA. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-kba-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -97,19 +103,22 @@ $AllLanguages = $false # Boolean | Indicator whether the question text should be # Configuration of KBA MFA method try { - Get-V2024MFAKbaConfig + Get-V2024MFAKbaConfig # Below is a request that includes all optional parameters - # Get-V2024MFAKbaConfig -V2024AllLanguages $AllLanguages + # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-mfa-okta-config This API returns the configuration of an Okta MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mfa-okta-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -137,7 +146,7 @@ Code | Description | Data Type # Configuration of Okta MFA method try { - Get-V2024MFAOktaConfig + Get-V2024MFAOktaConfig # Below is a request that includes all optional parameters # Get-V2024MFAOktaConfig @@ -147,9 +156,12 @@ try { } ``` [[Back to top]](#) + ## set-mfa-duo-config This API sets the configuration of an Duo MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfa-duo-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -190,19 +202,22 @@ $MfaDuoConfig = @"{ try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result + Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result # Below is a request that includes all optional parameters - # Set-V2024MFADuoConfig -V2024MfaDuoConfig $MfaDuoConfig + # Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-mfakba-config This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfakba-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -237,19 +252,22 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result + Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $KbaAnswerRequestItem + # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-mfa-okta-config This API sets the configuration of an Okta MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-mfa-okta-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -286,19 +304,22 @@ $MfaOktaConfig = @"{ try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result + Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result # Below is a request that includes all optional parameters - # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $MfaOktaConfig + # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-mfa-config This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-mfa-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -328,10 +349,10 @@ $Method = "okta-verify" # String | The name of the MFA method. The currently sup # MFA method's test configuration try { - Test-V2024MFAConfig -V2024Method $Method + Test-V2024MFAConfig -Method $Method # Below is a request that includes all optional parameters - # Test-V2024MFAConfig -V2024Method $Method + # Test-V2024MFAConfig -Method $Method } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md index bc7a91261..4f9320afc 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md @@ -26,10 +26,13 @@ Method | HTTP request | Description [**Get-V2024ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients [**Update-V2024ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client + ## create-managed-client Create a new managed client. The API returns a result that includes the managed client ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-managed-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -65,19 +68,22 @@ $ManagedClientRequest = @"{ try { $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-V2024ManagedClient -V2024ManagedClientRequest $Result + New-V2024ManagedClient -V2024ManagedClientRequest $Result # Below is a request that includes all optional parameters - # New-V2024ManagedClient -V2024ManagedClientRequest $ManagedClientRequest + # New-V2024ManagedClient -V2024ManagedClientRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-managed-client Delete an existing managed client. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -107,19 +113,22 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. # Delete Managed Client try { - Remove-V2024ManagedClient -V2024Id $Id + Remove-V2024ManagedClient -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024ManagedClient -V2024Id $Id + # Remove-V2024ManagedClient -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-managed-client Get managed client by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -150,19 +159,22 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. # Get Managed Client try { - Get-V2024ManagedClient -V2024Id $Id + Get-V2024ManagedClient -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ManagedClient -V2024Id $Id + # Get-V2024ManagedClient -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-managed-client-status Get a managed client's status, using its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-client-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -195,19 +207,22 @@ $Type = "CCG" # ManagedClientType | Managed client type to get status for. # Get Managed Client Status try { - Get-V2024ManagedClientStatus -V2024Id $Id -V2024Type $Type + Get-V2024ManagedClientStatus -Id $Id -Type $Type # Below is a request that includes all optional parameters - # Get-V2024ManagedClientStatus -V2024Id $Id -V2024Type $Type + # Get-V2024ManagedClientStatus -Id $Id -Type $Type } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-managed-clients List managed clients. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clients) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -243,19 +258,22 @@ $Filters = 'name eq "client name"' # String | Filter results using the standard # Get Managed Clients try { - Get-V2024ManagedClients + Get-V2024ManagedClients # Below is a request that includes all optional parameters - # Get-V2024ManagedClients -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + # Get-V2024ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-managed-client Update an existing managed client. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -294,10 +312,10 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedClient -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ManagedClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md index e444d0ee9..a821393e5 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md @@ -27,10 +27,13 @@ Method | HTTP request | Description [**Send-V2024ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration [**Update-V2024ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster + ## create-managed-cluster Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-managed-cluster) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -69,19 +72,22 @@ $ManagedClusterRequest = @"{ try { $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-V2024ManagedCluster -V2024ManagedClusterRequest $Result + New-V2024ManagedCluster -V2024ManagedClusterRequest $Result # Below is a request that includes all optional parameters - # New-V2024ManagedCluster -V2024ManagedClusterRequest $ManagedClusterRequest + # New-V2024ManagedCluster -V2024ManagedClusterRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-managed-cluster Delete an existing managed cluster. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-managed-cluster) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -113,19 +119,22 @@ $RemoveClients = $false # Boolean | Flag to determine the need to delete a clust # Delete Managed Cluster try { - Remove-V2024ManagedCluster -V2024Id $Id + Remove-V2024ManagedCluster -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024ManagedCluster -V2024Id $Id -V2024RemoveClients $RemoveClients + # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-client-log-configuration Get a managed cluster's log configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-client-log-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,19 +166,22 @@ $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to # Get Managed Cluster Log Configuration try { - Get-V2024ClientLogConfiguration -V2024Id $Id + Get-V2024ClientLogConfiguration -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ClientLogConfiguration -V2024Id $Id + # Get-V2024ClientLogConfiguration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-managed-cluster Get a managed cluster by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-cluster) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -200,19 +212,22 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. # Get Managed Cluster try { - Get-V2024ManagedCluster -V2024Id $Id + Get-V2024ManagedCluster -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ManagedCluster -V2024Id $Id + # Get-V2024ManagedCluster -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-managed-clusters List current organization's managed clusters, based on request context. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-managed-clusters) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -248,19 +263,22 @@ $Filters = 'operational eq "operation"' # String | Filter results using the stan # Get Managed Clusters try { - Get-V2024ManagedClusters + Get-V2024ManagedClusters # Below is a request that includes all optional parameters - # Get-V2024ManagedClusters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + # Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-client-log-configuration Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-client-log-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -294,19 +312,22 @@ $PutClientLogConfigurationRequest = @""@ try { $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-V2024ClientLogConfiguration -V2024Id $Id -V2024PutClientLogConfigurationRequest $Result + Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result # Below is a request that includes all optional parameters - # Send-V2024ClientLogConfiguration -V2024Id $Id -V2024PutClientLogConfigurationRequest $PutClientLogConfigurationRequest + # Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-managed-cluster Update an existing managed cluster. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-managed-cluster) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -345,10 +366,10 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedCluster -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ManagedCluster -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md index 63e442e5b..aee31c5b6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md @@ -81,9 +81,12 @@ Method | HTTP request | Description [**Deny-V2024NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request [**Update-V2024NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record + ## approve-non-employee-request Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -118,20 +121,23 @@ $NonEmployeeApprovalDecision = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeApprovalDecision $Result + Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result # Below is a request that includes all optional parameters - # Approve-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeApprovalDecision $NonEmployeeApprovalDecision + # Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-record This request will create a non-employee record. Requires role context of `idn:nesr:create` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -175,19 +181,22 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result + New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $NonEmployeeRequestBody + # New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-request This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -231,19 +240,22 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result + New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $NonEmployeeRequestBody + # New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-source This request will create a non-employee source. Requires role context of `idn:nesr:create` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -299,20 +311,23 @@ $NonEmployeeSourceRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result + New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result # Below is a request that includes all optional parameters - # New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody + # New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-source-schema-attributes This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. Requires role context of `idn:nesr:create` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-source-schema-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -352,20 +367,23 @@ $NonEmployeeSchemaAttributeBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result + New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result # Below is a request that includes all optional parameters - # New-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody + # New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-record This request will delete a non-employee record. Requires role context of `idn:nesr:delete` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -395,19 +413,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID # Delete Non-Employee Record try { - Remove-V2024NonEmployeeRecord -V2024Id $Id + Remove-V2024NonEmployeeRecord -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeRecord -V2024Id $Id + # Remove-V2024NonEmployeeRecord -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-records-in-bulk This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-records-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -438,20 +459,23 @@ $DeleteNonEmployeeRecordsInBulkRequest = @""@ try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest - Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $Result + Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest + # Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecordsInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-request This request will delete a non-employee request. Requires role context of `idn:nesr:delete` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -482,21 +506,24 @@ $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id # Delete Non-Employee Request try { - Remove-V2024NonEmployeeRequest -V2024Id $Id + Remove-V2024NonEmployeeRequest -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeRequest -V2024Id $Id + # Remove-V2024NonEmployeeRequest -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-schema-attribute This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-schema-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -528,19 +555,22 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id # Delete a Schema Attribute for Non-Employee Source try { - Remove-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId + Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId + # Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-source This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -570,19 +600,22 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id # Delete Non-Employee Source try { - Remove-V2024NonEmployeeSource -V2024SourceId $SourceId + Remove-V2024NonEmployeeSource -SourceId $SourceId # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeSource -V2024SourceId $SourceId + # Remove-V2024NonEmployeeSource -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-source-schema-attributes This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-non-employee-source-schema-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -612,19 +645,22 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id # Delete all custom schema attributes for Non-Employee Source try { - Remove-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId + Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId + # Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-non-employee-records This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-non-employee-records) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -655,19 +691,22 @@ $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) # Exports Non-Employee Records to CSV try { - Export-V2024NonEmployeeRecords -V2024Id $Id + Export-V2024NonEmployeeRecords -Id $Id # Below is a request that includes all optional parameters - # Export-V2024NonEmployeeRecords -V2024Id $Id + # Export-V2024NonEmployeeRecords -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeRecords" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-non-employee-source-schema-template This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-non-employee-source-schema-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -698,22 +737,25 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) # Exports Source Schema Template try { - Export-V2024NonEmployeeSourceSchemaTemplate -V2024Id $Id + Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id # Below is a request that includes all optional parameters - # Export-V2024NonEmployeeSourceSchemaTemplate -V2024Id $Id + # Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeSourceSchemaTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-approval Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-approval) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -745,16 +787,17 @@ $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be inc # Get a non-employee approval item detail try { - Get-V2024NonEmployeeApproval -V2024Id $Id + Get-V2024NonEmployeeApproval -Id $Id # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeApproval -V2024Id $Id -V2024IncludeDetail $IncludeDetail + # Get-V2024NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApproval" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-approval-summary This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or @@ -762,6 +805,8 @@ she may request a summary of all non-employee approval requests assigned to a pa 2. The current user is an approver, in which case "me" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-approval-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -791,21 +836,24 @@ $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID # Get Summary of Non-Employee Approval Requests try { - Get-V2024NonEmployeeApprovalSummary -V2024RequestedFor $RequestedFor + Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeApprovalSummary -V2024RequestedFor $RequestedFor + # Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovalSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-bulk-upload-status The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-bulk-upload-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -835,20 +883,23 @@ $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) # Obtain the status of bulk upload on the source try { - Get-V2024NonEmployeeBulkUploadStatus -V2024Id $Id + Get-V2024NonEmployeeBulkUploadStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeBulkUploadStatus -V2024Id $Id + # Get-V2024NonEmployeeBulkUploadStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeBulkUploadStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-record This gets a non-employee record. Requires role context of `idn:nesr:read` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -878,16 +929,17 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID # Get a Non-Employee Record try { - Get-V2024NonEmployeeRecord -V2024Id $Id + Get-V2024NonEmployeeRecord -Id $Id # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeRecord -V2024Id $Id + # Get-V2024NonEmployeeRecord -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-request This gets a non-employee request. There are two contextual uses for this endpoint: @@ -895,6 +947,8 @@ There are two contextual uses for this endpoint: can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -925,16 +979,17 @@ $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id # Get a Non-Employee Request try { - Get-V2024NonEmployeeRequest -V2024Id $Id + Get-V2024NonEmployeeRequest -Id $Id # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeRequest -V2024Id $Id + # Get-V2024NonEmployeeRequest -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-request-summary This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or @@ -942,6 +997,8 @@ she may request a summary of all non-employee approval requests assigned to a pa 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-request-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -971,19 +1028,22 @@ $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID # Get Summary of Non-Employee Requests try { - Get-V2024NonEmployeeRequestSummary -V2024RequestedFor $RequestedFor + Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeRequestSummary -V2024RequestedFor $RequestedFor + # Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequestSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-schema-attribute This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-schema-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1015,16 +1075,17 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id # Get Schema Attribute Non-Employee Source try { - Get-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId + Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId + # Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-source This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or @@ -1032,6 +1093,8 @@ she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1061,20 +1124,23 @@ $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id # Get a Non-Employee Source try { - Get-V2024NonEmployeeSource -V2024SourceId $SourceId + Get-V2024NonEmployeeSource -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSource -V2024SourceId $SourceId + # Get-V2024NonEmployeeSource -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-non-employee-source-schema-attributes This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-non-employee-source-schema-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1105,19 +1171,22 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id # List Schema Attributes Non-Employee Source try { - Get-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId + Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId + # Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-non-employee-records-in-bulk This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-non-employee-records-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1150,16 +1219,17 @@ $Data = # System.IO.FileInfo | # Imports, or Updates, Non-Employee Records try { - Import-V2024NonEmployeeRecordsInBulk -V2024Id $Id -V2024Data $Data + Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data # Below is a request that includes all optional parameters - # Import-V2024NonEmployeeRecordsInBulk -V2024Id $Id -V2024Data $Data + # Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024NonEmployeeRecordsInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-non-employee-approvals This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: @@ -1167,6 +1237,8 @@ There are two contextual uses for this endpoint: can list the approvals for any approver. 2. The user owns the requested approval. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-approvals) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1206,21 +1278,24 @@ $Sorters = "created" # String | Sort results using the standard syntax described # Get List of Non-Employee Approval Requests try { - Get-V2024NonEmployeeApprovals + Get-V2024NonEmployeeApprovals # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeApprovals -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovals" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-non-employee-records This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-records) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1258,16 +1333,17 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re # List Non-Employee Records try { - Get-V2024NonEmployeeRecords + Get-V2024NonEmployeeRecords # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeRecords -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecords" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-non-employee-requests This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or @@ -1275,6 +1351,8 @@ she may request a list non-employee requests assigned to a particular account ma 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-requests) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1314,16 +1392,17 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re # List Non-Employee Requests try { - Get-V2024NonEmployeeRequests -V2024RequestedFor $RequestedFor + Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeRequests -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequests" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-non-employee-sources This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or @@ -1331,6 +1410,8 @@ she may request a list sources assigned to a particular account manager by passi 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-sources) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1370,16 +1451,17 @@ $Sorters = "name,created" # String | Sort results using the standard syntax desc # List Non-Employee Sources try { - Get-V2024NonEmployeeSources -V2024RequestedFor $RequestedFor + Get-V2024NonEmployeeSources -RequestedFor $RequestedFor # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSources -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024NonEmployeeCount $NonEmployeeCount -V2024Sorters $Sorters + # Get-V2024NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-non-employee-record This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they @@ -1387,6 +1469,8 @@ update all available fields. 2. The user is owner of the source, in this case they can only update the end date. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1425,21 +1509,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024NonEmployeeRecord -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024NonEmployeeRecord -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeRecord -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024NonEmployeeRecord -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-non-employee-schema-attribute This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-non-employee-schema-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1480,19 +1567,22 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId -V2024JsonPatchOperation $Result + Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-non-employee-source patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1530,19 +1620,22 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024NonEmployeeSource -V2024SourceId $SourceId -V2024JsonPatchOperation $Result + Update-V2024NonEmployeeSource -SourceId $SourceId -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeSource -V2024SourceId $SourceId -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024NonEmployeeSource -SourceId $SourceId -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reject-non-employee-request This endpoint will reject an approval item request and notify user. The current user must be the requested approver. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1577,16 +1670,17 @@ $NonEmployeeRejectApprovalDecision = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeRejectApprovalDecision $Result + Deny-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeRejectApprovalDecision $Result # Below is a request that includes all optional parameters - # Deny-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision + # Deny-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeRejectApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-non-employee-record This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they @@ -1594,6 +1688,8 @@ update all available fields. 2. The user is owner of the source, in this case they can only update the end date. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1640,10 +1736,10 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-V2024NonEmployeeRecord -V2024Id $Id -V2024NonEmployeeRequestBody $Result + Update-V2024NonEmployeeRecord -Id $Id -V2024NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeRecord -V2024Id $Id -V2024NonEmployeeRequestBody $NonEmployeeRequestBody + # Update-V2024NonEmployeeRecord -Id $Id -V2024NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md index cf756ea55..2971ea5ff 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md @@ -33,9 +33,15 @@ Method | HTTP request | Description [**Send-V2024MailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain [**Send-V2024TestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification + ## create-domain-dkim +:::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. +::: Create a domain to be verified via DKIM (DomainKeys Identified Mail) +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-domain-dkim) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -71,21 +77,27 @@ $DomainAddress = @"{ try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress - New-V2024DomainDkim -V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result + New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result # Below is a request that includes all optional parameters - # New-V2024DomainDkim -V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $DomainAddress + # New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-notification-template +:::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 creates a template for your site. You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-notification-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -135,19 +147,25 @@ $TemplateDto = @"{ try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto - New-V2024NotificationTemplate -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result + New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result # Below is a request that includes all optional parameters - # New-V2024NotificationTemplate -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $TemplateDto + # New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-verified-from-address +:::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. +::: Create a new sender email address and initiate verification process. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-verified-from-address) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -185,19 +203,25 @@ $EmailStatusDto = @"{ try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto - New-V2024VerifiedFromAddress -V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result + New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result # Below is a request that includes all optional parameters - # New-V2024VerifiedFromAddress -V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $EmailStatusDto + # New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-notification-templates-in-bulk +:::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 lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-notification-templates-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -235,19 +259,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto - Remove-V2024NotificationTemplatesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result + Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result # Below is a request that includes all optional parameters - # Remove-V2024NotificationTemplatesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $TemplateBulkDeleteDto + # Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-verified-from-address +:::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. +::: Delete a verified sender email address +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-verified-from-address) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -280,19 +310,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Delete Verified From Address try { - Remove-V2024VerifiedFromAddress -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024VerifiedFromAddress -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VerifiedFromAddress" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-dkim-attributes +:::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. +::: Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-dkim-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -322,19 +358,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get DKIM Attributes try { - Get-V2024DkimAttributes -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024DkimAttributes -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DkimAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-mail-from-attributes +:::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. +::: Retrieve MAIL FROM attributes for a given AWS SES identity. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mail-from-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -366,19 +408,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get MAIL FROM Attributes try { - Get-V2024MailFromAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024MailFromAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MailFromAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-notification-template +:::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 gets a template that you have modified for your site by Id. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-notification-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -410,20 +458,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Notification Template By Id try { - Get-V2024NotificationTemplate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NotificationTemplate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-notifications-template-context +:::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. +::: The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes that will be available per tenant (organization). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-notifications-template-context) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -453,19 +507,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Notification Template Context try { - Get-V2024NotificationsTemplateContext -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NotificationsTemplateContext -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationsTemplateContext" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-from-addresses +:::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. +::: Retrieve a list of sender email addresses and their verification statuses +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-from-addresses) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -504,19 +564,25 @@ $Sorters = "email" # String | Sort results using the standard syntax described i # List From Addresses try { - Get-V2024FromAddresses -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024FromAddresses -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FromAddresses" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-notification-preferences +:::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. +::: Returns a list of notification preferences for tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-preferences) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -547,19 +613,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # List Notification Preferences for tenant. try { - Get-V2024NotificationPreferences -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NotificationPreferences -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationPreferences" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-notification-template-defaults +:::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 lists the default templates used for notifications, such as emails from IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-template-defaults) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -595,19 +667,25 @@ $Filters = 'key eq "cloud_manual_work_item_summary"' # String | Filter results u # List Notification Template Defaults try { - Get-V2024NotificationTemplateDefaults -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NotificationTemplateDefaults -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + # Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplateDefaults" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-notification-templates +:::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 lists the templates that you have modified for your site. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-templates) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -643,19 +721,25 @@ $Filters = 'medium eq "EMAIL"' # String | Filter results using the standard synt # List Notification Templates try { - Get-V2024NotificationTemplates -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NotificationTemplates -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + # Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplates" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-mail-from-attributes +:::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. +::: Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-mail-from-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -691,19 +775,25 @@ $MailFromAttributesDto = @"{ try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto - Send-V2024MailFromAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result + Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result # Below is a request that includes all optional parameters - # Send-V2024MailFromAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $MailFromAttributesDto + # Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-test-notification +:::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. +::: Send a Test Notification +[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-test-notification) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -741,10 +831,10 @@ $SendTestNotificationRequestDto = @"{ try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto - Send-V2024TestNotification -V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result + Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result # Below is a request that includes all optional parameters - # Send-V2024TestNotification -V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $SendTestNotificationRequestDto + # Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md index c261686f3..c94cc6b6d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md @@ -26,9 +26,12 @@ Method | HTTP request | Description [**Get-V2024OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients [**Update-V2024OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client + ## create-oauth-client This creates an OAuth client. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -75,19 +78,22 @@ $CreateOAuthClientRequest = @"{ try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-V2024OauthClient -V2024CreateOAuthClientRequest $Result + New-V2024OauthClient -V2024CreateOAuthClientRequest $Result # Below is a request that includes all optional parameters - # New-V2024OauthClient -V2024CreateOAuthClientRequest $CreateOAuthClientRequest + # New-V2024OauthClient -V2024CreateOAuthClientRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-oauth-client This deletes an OAuth client. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -118,19 +124,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id # Delete OAuth Client try { - Remove-V2024OauthClient -V2024Id $Id + Remove-V2024OauthClient -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024OauthClient -V2024Id $Id + # Remove-V2024OauthClient -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024OauthClient" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-oauth-client This gets details of an OAuth client. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -161,19 +170,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id # Get OAuth Client try { - Get-V2024OauthClient -V2024Id $Id + Get-V2024OauthClient -Id $Id # Below is a request that includes all optional parameters - # Get-V2024OauthClient -V2024Id $Id + # Get-V2024OauthClient -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClient" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-oauth-clients This gets a list of OAuth clients. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-oauth-clients) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -203,19 +215,22 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin # List OAuth Clients try { - Get-V2024OauthClients + Get-V2024OauthClients # Below is a request that includes all optional parameters - # Get-V2024OauthClients -V2024Filters $Filters + # Get-V2024OauthClients -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClients" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-oauth-client This performs a targeted update to the field(s) of an OAuth client. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -254,10 +269,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024OauthClient -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024OauthClient -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024OauthClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024OauthClient -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OauthClient" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md index d7686d694..a1dc7cbba 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md @@ -23,9 +23,15 @@ Method | HTTP request | Description [**Get-V2024ValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get Valid Time Zones [**Update-V2024OrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch Org Config + ## get-org-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. +::: Get the current organization's configuration settings, only external accessible properties. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -56,19 +62,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Org Config Settings try { - Get-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OrgConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-valid-time-zones +:::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. +::: List the valid time zones that can be set in organization configurations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-valid-time-zones) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -104,19 +116,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Get Valid Time Zones try { - Get-V2024ValidTimeZones -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ValidTimeZones -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ValidTimeZones" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-org-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. +::: Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -155,10 +173,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md index 93c6d223e..0d4d44cfa 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md @@ -27,11 +27,14 @@ Method | HTTP request | Description [**Get-V2024PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config [**Send-V2024PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config + ## create-password-org-config This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -67,19 +70,22 @@ $PasswordOrgConfig = @"{ try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result + New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result # Below is a request that includes all optional parameters - # New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig + # New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-password-org-config This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -107,7 +113,7 @@ Code | Description | Data Type # Get Password Org Config try { - Get-V2024PasswordOrgConfig + Get-V2024PasswordOrgConfig # Below is a request that includes all optional parameters # Get-V2024PasswordOrgConfig @@ -117,11 +123,14 @@ try { } ``` [[Back to top]](#) + ## put-password-org-config This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-password-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,10 +166,10 @@ $PasswordOrgConfig = @"{ try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result + Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result # Below is a request that includes all optional parameters - # Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig + # Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordOrgConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordDictionaryApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordDictionaryApi.md index be70a7b52..c5c167f10 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordDictionaryApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordDictionaryApi.md @@ -67,6 +67,7 @@ Method | HTTP request | Description [**Get-V2024PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary [**Send-V2024PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary + ## get-password-dictionary This gets password dictionary for the organization. The password dictionary file can contain lines that are: @@ -98,6 +99,8 @@ qazxsws ``` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-dictionary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -126,7 +129,7 @@ Code | Description | Data Type # Get Password Dictionary try { - Get-V2024PasswordDictionary + Get-V2024PasswordDictionary # Below is a request that includes all optional parameters # Get-V2024PasswordDictionary @@ -136,6 +139,7 @@ try { } ``` [[Back to top]](#) + ## put-password-dictionary This updates password dictionary for the organization. The password dictionary file can contain lines that are: @@ -167,6 +171,8 @@ qazxsws ``` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-password-dictionary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -198,10 +204,10 @@ $File = # System.IO.FileInfo | (optional) # Update Password Dictionary try { - Send-V2024PasswordDictionary + Send-V2024PasswordDictionary # Below is a request that includes all optional parameters - # Send-V2024PasswordDictionary -V2024File $File + # Send-V2024PasswordDictionary -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordDictionary" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md index 5df8a339f..cf69cc9fe 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md @@ -46,9 +46,15 @@ Method | HTTP request | Description [**Search-V2024PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info [**Set-V2024Password**](#set-password) | **POST** `/set-password` | Set Identity's Password + ## create-digit-token +:::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 API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-digit-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -85,19 +91,22 @@ $PasswordDigitTokenReset = @"{ try { $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset - New-V2024DigitToken -V2024XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result + New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result # Below is a request that includes all optional parameters - # New-V2024DigitToken -V2024XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $PasswordDigitTokenReset + # New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-password-change-status This API returns the status of a password change request. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-change-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -128,20 +137,23 @@ $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID # Get Password Change Request Status try { - Get-V2024PasswordChangeStatus -V2024Id $Id + Get-V2024PasswordChangeStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2024PasswordChangeStatus -V2024Id $Id + # Get-V2024PasswordChangeStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordChangeStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## query-password-info This API is used to query password related information. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/query-password-info) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -175,16 +187,17 @@ $PasswordInfoQueryDTO = @"{ try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $Result + Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $Result # Below is a request that includes all optional parameters - # Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $PasswordInfoQueryDTO + # Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PasswordInfo" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-password This API is used to set a password for an identity. @@ -207,6 +220,8 @@ If you are using a Windows machine, refer to this [guide](https://tecadmin.net/i You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-password) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -243,10 +258,10 @@ $PasswordChangeRequest = @"{ try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-V2024Password -V2024PasswordChangeRequest $Result + Set-V2024Password -V2024PasswordChangeRequest $Result # Below is a request that includes all optional parameters - # Set-V2024Password -V2024PasswordChangeRequest $PasswordChangeRequest + # Set-V2024Password -V2024PasswordChangeRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Password" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md index 0e5068947..3f552003c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md @@ -31,9 +31,12 @@ Method | HTTP request | Description [**Get-V2024PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies [**Set-V2024PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID + ## create-password-policy This API creates the specified password policy. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -97,19 +100,22 @@ $PasswordPolicyV3Dto = @"{ try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $Result + New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters - # New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $PasswordPolicyV3Dto + # New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-password-policy This API deletes the specified password policy. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-password-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -140,19 +146,22 @@ $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to # Delete Password Policy by ID try { - Remove-V2024PasswordPolicy -V2024Id $Id + Remove-V2024PasswordPolicy -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024PasswordPolicy -V2024Id $Id + # Remove-V2024PasswordPolicy -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-password-policy-by-id This API returns the password policy for the specified ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-policy-by-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -183,20 +192,23 @@ $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to # Get Password Policy by ID try { - Get-V2024PasswordPolicyById -V2024Id $Id + Get-V2024PasswordPolicyById -Id $Id # Below is a request that includes all optional parameters - # Get-V2024PasswordPolicyById -V2024Id $Id + # Get-V2024PasswordPolicyById -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicyById" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-password-policies This gets list of all Password Policies. Requires role of ORG_ADMIN +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-password-policies) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -230,19 +242,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List Password Policies try { - Get-V2024PasswordPolicies + Get-V2024PasswordPolicies # Below is a request that includes all optional parameters - # Get-V2024PasswordPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicies" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-password-policy This API updates the specified password policy. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-password-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -308,10 +323,10 @@ $PasswordPolicyV3Dto = @"{ try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-V2024PasswordPolicy -V2024Id $Id -V2024PasswordPolicyV3Dto $Result + Set-V2024PasswordPolicy -Id $Id -V2024PasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters - # Set-V2024PasswordPolicy -V2024Id $Id -V2024PasswordPolicyV3Dto $PasswordPolicyV3Dto + # Set-V2024PasswordPolicy -Id $Id -V2024PasswordPolicyV3Dto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024PasswordPolicy" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md index b24f4a81d..2f9c4ac0a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md @@ -55,9 +55,12 @@ Method | HTTP request | Description [**Get-V2024PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List [**Update-V2024PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID + ## create-password-sync-group This API creates a password sync group based on the specifications provided. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -95,19 +98,22 @@ $PasswordSyncGroup = @"{ try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result + New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result # Below is a request that includes all optional parameters - # New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $PasswordSyncGroup + # New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-password-sync-group This API deletes the specified password sync group. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -137,19 +143,22 @@ $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync # Delete Password Sync Group by ID try { - Remove-V2024PasswordSyncGroup -V2024Id $Id + Remove-V2024PasswordSyncGroup -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024PasswordSyncGroup -V2024Id $Id + # Remove-V2024PasswordSyncGroup -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordSyncGroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-password-sync-group This API returns the sync group for the specified ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -180,19 +189,22 @@ $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync # Get Password Sync Group by ID try { - Get-V2024PasswordSyncGroup -V2024Id $Id + Get-V2024PasswordSyncGroup -Id $Id # Below is a request that includes all optional parameters - # Get-V2024PasswordSyncGroup -V2024Id $Id + # Get-V2024PasswordSyncGroup -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-password-sync-groups This API returns a list of password sync groups. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-password-sync-groups) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -226,19 +238,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Get Password Sync Group List try { - Get-V2024PasswordSyncGroups + Get-V2024PasswordSyncGroups # Below is a request that includes all optional parameters - # Get-V2024PasswordSyncGroups -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroups" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-password-sync-group This API updates the specified password sync group. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -279,10 +294,10 @@ $PasswordSyncGroup = @"{ try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-V2024PasswordSyncGroup -V2024Id $Id -V2024PasswordSyncGroup $Result + Update-V2024PasswordSyncGroup -Id $Id -V2024PasswordSyncGroup $Result # Below is a request that includes all optional parameters - # Update-V2024PasswordSyncGroup -V2024Id $Id -V2024PasswordSyncGroup $PasswordSyncGroup + # Update-V2024PasswordSyncGroup -Id $Id -V2024PasswordSyncGroup $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordSyncGroup" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md index 24e53c0f3..51bf2da37 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md @@ -33,9 +33,12 @@ Method | HTTP request | Description [**Get-V2024PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens [**Update-V2024PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token + ## create-personal-access-token This creates a personal access token. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-personal-access-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -70,19 +73,22 @@ $CreatePersonalAccessTokenRequest = @"{ try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $Result + New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $Result # Below is a request that includes all optional parameters - # New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest + # New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PersonalAccessToken" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-personal-access-token This deletes a personal access token. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-personal-access-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -113,19 +119,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id # Delete Personal Access Token try { - Remove-V2024PersonalAccessToken -V2024Id $Id + Remove-V2024PersonalAccessToken -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024PersonalAccessToken -V2024Id $Id + # Remove-V2024PersonalAccessToken -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PersonalAccessToken" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-personal-access-tokens This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-personal-access-tokens) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,20 +166,23 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin # List Personal Access Tokens try { - Get-V2024PersonalAccessTokens + Get-V2024PersonalAccessTokens # Below is a request that includes all optional parameters - # Get-V2024PersonalAccessTokens -V2024OwnerId $OwnerId -V2024Filters $Filters + # Get-V2024PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PersonalAccessTokens" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-personal-access-token This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-personal-access-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -209,10 +221,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024PersonalAccessToken -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024PersonalAccessToken -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024PersonalAccessToken -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024PersonalAccessToken -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PersonalAccessToken" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesApi.md index 0d714420a..6fd3e5250 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesApi.md @@ -22,9 +22,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-V2024PublicIdentities**](#get-public-identities) | **GET** `/public-identities` | Get list of public identities + ## get-public-identities Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-public-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -64,10 +67,10 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # Get list of public identities try { - Get-V2024PublicIdentities + Get-V2024PublicIdentities # Below is a request that includes all optional parameters - # Get-V2024PublicIdentities -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024AddCoreFilters $AddCoreFilters -V2024Sorters $Sorters + # Get-V2024PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentities" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md index ee507e2af..d70c0ba88 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md @@ -30,9 +30,12 @@ Method | HTTP request | Description [**Get-V2024PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration [**Update-V2024PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration + ## get-public-identity-config Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-public-identity-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -60,7 +63,7 @@ Code | Description | Data Type # Get the Public Identities Configuration try { - Get-V2024PublicIdentityConfig + Get-V2024PublicIdentityConfig # Below is a request that includes all optional parameters # Get-V2024PublicIdentityConfig @@ -70,9 +73,12 @@ try { } ``` [[Back to top]](#) + ## update-public-identity-config Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-public-identity-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -117,10 +123,10 @@ $PublicIdentityConfig = @"{ try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $Result + Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $Result # Below is a request that includes all optional parameters - # Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $PublicIdentityConfig + # Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PublicIdentityConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md index 1432bcdae..f5fec5356 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md @@ -25,9 +25,12 @@ Method | HTTP request | Description [**Get-V2024ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result [**Start-V2024Report**](#start-report) | **POST** `/reports/run` | Run Report + ## cancel-report Cancels a running report. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -57,19 +60,22 @@ $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to # Cancel Report try { - Suspend-V2024Report -V2024Id $Id + Suspend-V2024Report -Id $Id # Below is a request that includes all optional parameters - # Suspend-V2024Report -V2024Id $Id + # Suspend-V2024Report -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024Report" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-report Gets a report in file format. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -106,19 +112,22 @@ $Auditable = $true # Boolean | Enables auditing for current report download. Wil # Get Report File try { - Get-V2024Report -V2024TaskResultId $TaskResultId -V2024FileFormat $FileFormat + Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat # Below is a request that includes all optional parameters - # Get-V2024Report -V2024TaskResultId $TaskResultId -V2024FileFormat $FileFormat -V2024Name $Name -V2024Auditable $Auditable + # Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Report" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-report-result Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-report-result) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -150,19 +159,22 @@ $Completed = $true # Boolean | state of task result to apply ordering when resul # Get Report Result try { - Get-V2024ReportResult -V2024TaskResultId $TaskResultId + Get-V2024ReportResult -TaskResultId $TaskResultId # Below is a request that includes all optional parameters - # Get-V2024ReportResult -V2024TaskResultId $TaskResultId -V2024Completed $Completed + # Get-V2024ReportResult -TaskResultId $TaskResultId -Completed $Completed } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReportResult" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-report Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -199,10 +211,10 @@ $ReportDetails = @"{ try { $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails - Start-V2024Report -V2024ReportDetails $Result + Start-V2024Report -V2024ReportDetails $Result # Below is a request that includes all optional parameters - # Start-V2024Report -V2024ReportDetails $ReportDetails + # Start-V2024Report -V2024ReportDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Report" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RequestableObjectsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RequestableObjectsApi.md index 2e4d7c02c..108f68355 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RequestableObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RequestableObjectsApi.md @@ -22,10 +22,13 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-V2024RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List + ## list-requestable-objects This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. Any authenticated token can call this endpoint to see their requestable access items. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-requestable-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -75,10 +78,10 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # Requestable Objects List try { - Get-V2024RequestableObjects + Get-V2024RequestableObjects # Below is a request that includes all optional parameters - # Get-V2024RequestableObjects -V2024IdentityId $IdentityId -V2024Types $Types -V2024Term $Term -V2024Statuses $Statuses -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RequestableObjects" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RoleInsightsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RoleInsightsApi.md index 25e16b4dc..efcb5fd0b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RoleInsightsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RoleInsightsApi.md @@ -27,9 +27,18 @@ Method | HTTP request | Description [**Get-V2024RoleInsightsRequests**](#get-role-insights-requests) | **GET** `/role-insights/requests/{id}` | Returns metadata from prior request. [**Get-V2024RoleInsightsSummary**](#get-role-insights-summary) | **GET** `/role-insights/summary` | Get role insights summary information + ## create-role-insight-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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. +::: Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role-insight-requests) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -59,19 +68,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Generate insights for roles try { - New-V2024RoleInsightRequests -V2024XSailPointExperimental $XSailPointExperimental + New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024RoleInsightRequests -V2024XSailPointExperimental $XSailPointExperimental + # New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleInsightRequests" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## download-role-insights-entitlements-changes +:::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 returns the entitlement insights for a role. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/download-role-insights-entitlements-changes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -106,19 +121,25 @@ $Filters = 'name sw "r"' # String | Filter results using the standard syntax des # Download entitlement insights for a role try { - Invoke-V2024DownloadRoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Invoke-V2024DownloadRoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters + # Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-entitlement-changes-identities +:::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. +::: Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlement-changes-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -163,19 +184,25 @@ $Filters = 'name sw "Jan"' # String | Filter results using the standard syntax d # Get identities for a suggested entitlement (for a role) try { - Get-V2024EntitlementChangesIdentities -V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EntitlementChangesIdentities -V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental -V2024HasEntitlement $HasEntitlement -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChangesIdentities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insight +:::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 gets role insights information for a role. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insight) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -206,19 +233,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get a single role insight try { - Get-V2024RoleInsight -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsight -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsight" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insights +:::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 method returns detailed role insights for each role. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -257,19 +290,25 @@ $Filters = 'name sw "John"' # String | Filter results using the standard syntax # Get role insights try { - Get-V2024RoleInsights -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsights -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsights" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insights-current-entitlements +:::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 gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-current-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -302,19 +341,25 @@ $Filters = 'name sw "r"' # String | Filter results using the standard syntax des # Get current entitlement for a role try { - Get-V2024RoleInsightsCurrentEntitlements -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsCurrentEntitlements -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters + # Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsCurrentEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insights-entitlements-changes +:::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 returns entitlement insights for a role. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-entitlements-changes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -349,19 +394,28 @@ $Filters = 'name sw "Admin"' # String | Filter results using the standard syntax # Get entitlement insights for a role try { - Get-V2024RoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters + # Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsEntitlementsChanges" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insights-requests +:::caution deprecated +This endpoint has been deprecated and may be replaced or removed in future versions of the API. +::: +:::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 returns details of a prior role insights request. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-requests) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -393,19 +447,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Returns metadata from prior request. try { - Get-V2024RoleInsightsRequests -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsRequests -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsRequests" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-insights-summary +:::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 method returns high level summary information for role insights for a customer. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-insights-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -434,10 +494,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get role insights summary information try { - Get-V2024RoleInsightsSummary -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleInsightsSummary -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsSummary" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md index 8dffee239..2cb15c688 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md @@ -71,12 +71,15 @@ Method | HTTP request | Description [**Update-V2024RolesMetadataByIds**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles' Metadata by ID [**Update-V2024RolesMetadataByQuery**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles' Metadata by Query + ## create-role This API creates a role. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -264,22 +267,25 @@ $Role = @"{ try { $Result = ConvertFrom-JsonToRole -Json $Role - New-V2024Role -V2024Role $Result + New-V2024Role -V2024Role $Result # Below is a request that includes all optional parameters - # New-V2024Role -V2024Role $Role + # New-V2024Role -V2024Role $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Role" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-bulk-roles This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-bulk-roles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -312,19 +318,22 @@ $RoleBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $Result + Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $RoleBulkDeleteRequest + # Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkRoles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-metadata-from-role-by-key-and-value This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-metadata-from-role-by-key-and-value) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -358,21 +367,24 @@ $AttributeValue = "public" # String | Technical name of the Attribute Value. # Remove a Metadata From Role. try { - Remove-V2024MetadataFromRoleByKeyAndValue -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue # Below is a request that includes all optional parameters - # Remove-V2024MetadataFromRoleByKeyAndValue -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + # Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MetadataFromRoleByKeyAndValue" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-role This API deletes a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -402,19 +414,22 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role # Delete a Role try { - Remove-V2024Role -V2024Id $Id + Remove-V2024Role -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024Role -V2024Id $Id + # Remove-V2024Role -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Role" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-bulk-update-status This API returns a list of all unfinished bulk update process status of the tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-bulk-update-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -442,7 +457,7 @@ Code | Description | Data Type # Get Bulk-Update Statuses try { - Get-V2024BulkUpdateStatus + Get-V2024BulkUpdateStatus # Below is a request that includes all optional parameters # Get-V2024BulkUpdateStatus @@ -452,11 +467,14 @@ try { } ``` [[Back to top]](#) + ## get-bulk-update-status-by-id This API initial a request for one bulk update's status by bulk update Id returns the status of the bulk update process. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-bulk-update-status-by-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -486,20 +504,23 @@ $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update ta # Get Bulk-Update Status by ID try { - Get-V2024BulkUpdateStatusById -V2024Id $Id + Get-V2024BulkUpdateStatusById -Id $Id # Below is a request that includes all optional parameters - # Get-V2024BulkUpdateStatusById -V2024Id $Id + # Get-V2024BulkUpdateStatusById -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatusById" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role This API returns a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -529,19 +550,22 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role # Get a Role try { - Get-V2024Role -V2024Id $Id + Get-V2024Role -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Role -V2024Id $Id + # Get-V2024Role -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Role" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-assigned-identities +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-assigned-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -581,19 +605,25 @@ $Sorters = "aliasName,name" # String | Sort results using the standard syntax de # List Identities assigned a Role try { - Get-V2024RoleAssignedIdentities -V2024Id $Id + Get-V2024RoleAssignedIdentities -Id $Id # Below is a request that includes all optional parameters - # Get-V2024RoleAssignedIdentities -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignedIdentities" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-role-entitlements +:::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 API lists the Entitlements associated with a given role. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -635,19 +665,22 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de # List role's Entitlements try { - Get-V2024RoleEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024RoleEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleEntitlements" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-roles This API returns a list of Roles. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-roles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -691,16 +724,17 @@ $IncludeUnsegmented = $false # Boolean | Whether or not the response list should # List Roles try { - Get-V2024Roles + Get-V2024Roles # Below is a request that includes all optional parameters - # Get-V2024Roles -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented + # Get-V2024Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Roles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-role This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: @@ -723,6 +757,8 @@ The maximum supported length for the description field is 2000 characters. Longe When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -760,20 +796,23 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Role -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024Role -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Role -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024Role -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Role" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-roles-by-filter This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-roles-by-filter) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -823,19 +862,22 @@ $RoleListFilterDTO = @"{ # Filter Roles by Metadata try { - Search-V2024RolesByFilter + Search-V2024RolesByFilter # Below is a request that includes all optional parameters - # Search-V2024RolesByFilter -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented -V2024RoleListFilterDTO $RoleListFilterDTO + # Search-V2024RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -V2024RoleListFilterDTO $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-attribute-key-and-value-to-role This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-attribute-key-and-value-to-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -869,22 +911,25 @@ $AttributeValue = "public" # String | Technical name of the Attribute Value. # Add a Metadata to Role. try { - Update-V2024AttributeKeyAndValueToRole -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue # Below is a request that includes all optional parameters - # Update-V2024AttributeKeyAndValueToRole -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + # Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AttributeKeyAndValueToRole" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-roles-metadata-by-filter This API initiates a bulk update of metadata for one or more Roles by filter. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-filter) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -923,22 +968,25 @@ $RoleMetadataBulkUpdateByFilterRequest = @"{ try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest - Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $Result + Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $Result # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $RoleMetadataBulkUpdateByFilterRequest + # Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-roles-metadata-by-ids This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-ids) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -977,22 +1025,25 @@ $RoleMetadataBulkUpdateByIdRequest = @"{ try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest - Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $Result + Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $Result # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $RoleMetadataBulkUpdateByIdRequest + # Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-roles-metadata-by-query This API initiates a bulk update of metadata for one or more Roles by query. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum metadata value count for a single role is 25. Custom metadata update, including add, replace need suit licensed. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-roles-metadata-by-query) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1046,10 +1097,10 @@ $RoleMetadataBulkUpdateByQueryRequest = @"{ try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest - Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $Result + Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $Result # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $RoleMetadataBulkUpdateByQueryRequest + # Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md index 69de1a53c..2a05166b7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md @@ -32,9 +32,15 @@ Method | HTTP request | Description [**Update-V2024SIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute. [**Send-V2024SIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration + ## create-sim-integration +:::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. +::: Create a new SIM Integrations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-sim-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -85,19 +91,25 @@ $SimIntegrationDetails = @"{ try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2024SIMIntegration -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # New-V2024SIMIntegration -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails + # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-sim-integration +:::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. +::: Get the details of a SIM integration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sim-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -130,19 +142,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Delete a SIM integration try { - Remove-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sim-integration +:::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. +::: Get the details of a SIM integration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -175,19 +193,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get a SIM integration details. try { - Get-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sim-integrations +:::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. +::: List the existing SIM integrations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sim-integrations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -218,19 +242,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # List the existing SIM integrations. try { - Get-V2024SIMIntegrations -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SIMIntegrations -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-before-provisioning-rule +:::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. +::: Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-before-provisioning-rule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -266,19 +296,25 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\" try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024BeforeProvisioningRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result # Below is a request that includes all optional parameters - # Update-V2024BeforeProvisioningRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch + # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-sim-attributes +:::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. +::: Patch a SIM attribute given a JsonPatch object. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sim-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -314,19 +350,25 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\" try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024SIMAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result # Below is a request that includes all optional parameters - # Update-V2024SIMAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch + # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-sim-integration +:::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. +::: Update an existing SIM integration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-sim-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -379,10 +421,10 @@ $SimIntegrationDetails = @"{ try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Send-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails + # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md index cffb65361..9a2b8ce7f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md @@ -61,10 +61,13 @@ Method | HTTP request | Description [**Start-V2024SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org [**Start-V2024SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + ## create-sod-policy This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -150,20 +153,23 @@ $SodPolicy = @"{ try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2024SodPolicy -V2024SodPolicy $Result + New-V2024SodPolicy -V2024SodPolicy $Result # Below is a request that includes all optional parameters - # New-V2024SodPolicy -V2024SodPolicy $SodPolicy + # New-V2024SodPolicy -V2024SodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-sod-policy This deletes a specified SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -196,19 +202,22 @@ $Logical = $true # Boolean | Indicates whether this is a soft delete (logical tr # Delete SOD policy by ID try { - Remove-V2024SodPolicy -V2024Id $Id + Remove-V2024SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024SodPolicy -V2024Id $Id -V2024Logical $Logical + # Remove-V2024SodPolicy -Id $Id -Logical $Logical } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-sod-policy-schedule This deletes schedule for a specified SOD policy by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-sod-policy-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -239,19 +248,22 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy # Delete SOD policy schedule try { - Remove-V2024SodPolicySchedule -V2024Id $Id + Remove-V2024SodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024SodPolicySchedule -V2024Id $Id + # Remove-V2024SodPolicySchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-custom-violation-report This allows to download a specified named violation report for a given report reference. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-custom-violation-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -284,19 +296,22 @@ $FileName = "custom-name" # String | Custom Name for the file. # Download custom violation report try { - Get-V2024CustomViolationReport -V2024ReportResultId $ReportResultId -V2024FileName $FileName + Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName # Below is a request that includes all optional parameters - # Get-V2024CustomViolationReport -V2024ReportResultId $ReportResultId -V2024FileName $FileName + # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-default-violation-report This allows to download a violation report for a given report reference. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-default-violation-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -327,19 +342,22 @@ $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the re # Download violation report try { - Get-V2024DefaultViolationReport -V2024ReportResultId $ReportResultId + Get-V2024DefaultViolationReport -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Get-V2024DefaultViolationReport -V2024ReportResultId $ReportResultId + # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sod-all-report-run-status This endpoint gets the status for a violation report for all policy run. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-all-report-run-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -367,7 +385,7 @@ Code | Description | Data Type # Get multi-report run task status try { - Get-V2024SodAllReportRunStatus + Get-V2024SodAllReportRunStatus # Below is a request that includes all optional parameters # Get-V2024SodAllReportRunStatus @@ -377,10 +395,13 @@ try { } ``` [[Back to top]](#) + ## get-sod-policy This gets specified SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -411,19 +432,22 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy # Get SOD policy by ID try { - Get-V2024SodPolicy -V2024Id $Id + Get-V2024SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SodPolicy -V2024Id $Id + # Get-V2024SodPolicy -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sod-policy-schedule This endpoint gets a specified SOD policy's schedule. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-policy-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -453,19 +477,22 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy # Get SOD policy schedule try { - Get-V2024SodPolicySchedule -V2024Id $Id + Get-V2024SodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SodPolicySchedule -V2024Id $Id + # Get-V2024SodPolicySchedule -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sod-violation-report-run-status This gets the status for a violation report run task that has already been invoked. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-violation-report-run-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -496,19 +523,22 @@ $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of th # Get violation report run status try { - Get-V2024SodViolationReportRunStatus -V2024ReportResultId $ReportResultId + Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportRunStatus -V2024ReportResultId $ReportResultId + # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sod-violation-report-status This gets the status for a violation report run task that has already been invoked. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sod-violation-report-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -539,20 +569,23 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation # Get SOD violation report status try { - Get-V2024SodViolationReportStatus -V2024Id $Id + Get-V2024SodViolationReportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportStatus -V2024Id $Id + # Get-V2024SodViolationReportStatus -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-sod-policies This gets list of all SOD policies. Requires role of ORG_ADMIN +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sod-policies) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -590,21 +623,24 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described # List SOD policies try { - Get-V2024SodPolicies + Get-V2024SodPolicies # Below is a request that includes all optional parameters - # Get-V2024SodPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-sod-policy Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -643,19 +679,22 @@ $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SodPolicy -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SodPolicy -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-policy-schedule This updates schedule for a specified SOD policy. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-policy-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -773,20 +812,23 @@ $SodPolicySchedule = @"{ try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2024PolicySchedule -V2024Id $Id -V2024SodPolicySchedule $Result + Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result # Below is a request that includes all optional parameters - # Send-V2024PolicySchedule -V2024Id $Id -V2024SodPolicySchedule $SodPolicySchedule + # Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-sod-policy This updates a specified SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -875,19 +917,22 @@ $SodPolicy = @"{ try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2024SodPolicy -V2024Id $Id -V2024SodPolicy $Result + Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result # Below is a request that includes all optional parameters - # Send-V2024SodPolicy -V2024Id $Id -V2024SodPolicy $SodPolicy + # Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-evaluate-sod-policy Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-evaluate-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -917,19 +962,22 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run # Evaluate one policy by ID try { - Start-V2024EvaluateSodPolicy -V2024Id $Id + Start-V2024EvaluateSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Start-V2024EvaluateSodPolicy -V2024Id $Id + # Start-V2024EvaluateSodPolicy -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-sod-all-policies-for-org Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-sod-all-policies-for-org) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -961,19 +1009,22 @@ $MultiPolicyRequest = @"{ # Runs all policies for org try { - Start-V2024SodAllPoliciesForOrg + Start-V2024SodAllPoliciesForOrg # Below is a request that includes all optional parameters - # Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $MultiPolicyRequest + # Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-sod-policy This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1004,10 +1055,10 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run # Runs SOD policy violation report try { - Start-V2024SodPolicy -V2024Id $Id + Start-V2024SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Start-V2024SodPolicy -V2024Id $Id + # Start-V2024SodPolicy -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md index db41b6b8e..a94f05910 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md @@ -38,9 +38,12 @@ Method | HTTP request | Description [**Start-V2024PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. [**Start-V2024ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations + ## start-predict-sod-violations This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-predict-sod-violations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -83,19 +86,22 @@ $IdentityWithNewAccess = @"{ try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result + Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $IdentityWithNewAccess + # Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-violation-check This API initiates a SOD policy verification asynchronously. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-violation-check) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -127,10 +133,10 @@ $IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, access try { $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result + Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $IdentityWithNewAccess1 + # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md index dd008879c..8471c58fe 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md @@ -25,10 +25,16 @@ Method | HTTP request | Description [**Import-V2024SpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job [**Get-V2024SpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details + ## export-sp-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. +::: This post will export objects from the tenant to a JSON configuration file. For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/export-sp-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -64,21 +70,27 @@ $ExportPayload = @"{ try { $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result + Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result # Below is a request that includes all optional parameters - # Export-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $ExportPayload + # Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sp-config-export +:::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 gets the export file resulting from the export job with the requested `id` and downloads it to a file. The request will need one of the following security scopes: - sp:config:read - sp:config:manage +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-export) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -111,21 +123,27 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Download export job result. try { - Get-V2024SpConfigExport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sp-config-export-status +:::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 gets the status of the export job identified by the `id` parameter. The request will need one of the following security scopes: - sp:config:read - sp:config:manage +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-export-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -158,21 +176,27 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get export job status try { - Get-V2024SpConfigExportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sp-config-import +:::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 gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope: - sp:config:manage +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sp-config-import) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -205,23 +229,29 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Download import job result try { - Get-V2024SpConfigImport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sp-config-import-status +:::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 gets the status of the import job identified by the `id` parameter. 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/get-sp-config-import-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -254,17 +284,21 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get import job status try { - Get-V2024SpConfigImportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-sp-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. +::: "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\ @@ -279,6 +313,8 @@ try { \ Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects)." +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-sp-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -315,19 +351,25 @@ $Options = @""@ # Initiates configuration objects import job try { - Import-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data + Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data # Below is a request that includes all optional parameters - # Import-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data -V2024Preview $Preview -V2024Options $Options + # Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data -Preview $Preview -V2024Options $Options } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-sp-config-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. +::: This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -358,10 +400,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get config object details try { - Get-V2024SpConfigObjects -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md index 7f436c450..5ccd6f10c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md @@ -34,10 +34,13 @@ Method | HTTP request | Description [**Get-V2024SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches [**Send-V2024SavedSearch**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search + ## create-saved-search Creates a new saved search. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-saved-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -68,20 +71,23 @@ $CreateSavedSearchRequest = @""@ try { $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result + New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result # Below is a request that includes all optional parameters - # New-V2024SavedSearch -V2024CreateSavedSearchRequest $CreateSavedSearchRequest + # New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-saved-search Deletes the specified saved search. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-saved-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -112,20 +118,23 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document # Delete document by ID try { - Remove-V2024SavedSearch -V2024Id $Id + Remove-V2024SavedSearch -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024SavedSearch -V2024Id $Id + # Remove-V2024SavedSearch -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## execute-saved-search Executes the specified saved search. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/execute-saved-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -169,20 +178,23 @@ $SearchArguments = @"{ try { $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-V2024ExecuteSavedSearch -V2024Id $Id -V2024SearchArguments $Result + Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result # Below is a request that includes all optional parameters - # Invoke-V2024ExecuteSavedSearch -V2024Id $Id -V2024SearchArguments $SearchArguments + # Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-saved-search Returns the specified saved search. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-saved-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -213,20 +225,23 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document # Return saved search by ID try { - Get-V2024SavedSearch -V2024Id $Id + Get-V2024SavedSearch -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SavedSearch -V2024Id $Id + # Get-V2024SavedSearch -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-saved-searches Returns a list of saved searches. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-saved-searches) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -262,22 +277,25 @@ $Filters = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filte # A list of Saved Searches try { - Get-V2024SavedSearches + Get-V2024SavedSearches # Below is a request that includes all optional parameters - # Get-V2024SavedSearches -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + # Get-V2024SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-saved-search Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-saved-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -354,10 +372,10 @@ $SavedSearch = @"{ try { $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-V2024SavedSearch -V2024Id $Id -V2024SavedSearch $Result + Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result # Below is a request that includes all optional parameters - # Send-V2024SavedSearch -V2024Id $Id -V2024SavedSearch $SavedSearch + # Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md index e02b95ca8..905a25364 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md @@ -50,10 +50,13 @@ Method | HTTP request | Description [**Invoke-V2024UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search [**Update-V2024ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search + ## create-scheduled-search Creates a new scheduled search. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -85,20 +88,23 @@ $CreateScheduledSearchRequest = @"{savedSearchId=9c620e13-cd33-4804-a13d-403bd7b try { $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result + New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result # Below is a request that includes all optional parameters - # New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $CreateScheduledSearchRequest + # New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-scheduled-search Deletes the specified scheduled search. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -129,19 +135,22 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document # Delete a Scheduled Search try { - Remove-V2024ScheduledSearch -V2024Id $Id + Remove-V2024ScheduledSearch -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024ScheduledSearch -V2024Id $Id + # Remove-V2024ScheduledSearch -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-scheduled-search Returns the specified scheduled search. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -172,20 +181,23 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document # Get a Scheduled Search try { - Get-V2024ScheduledSearch -V2024Id $Id + Get-V2024ScheduledSearch -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ScheduledSearch -V2024Id $Id + # Get-V2024ScheduledSearch -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-scheduled-search Returns a list of scheduled searches. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -222,20 +234,23 @@ $Filters = 'savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"' # String | # List scheduled searches try { - Get-V2024ScheduledSearch + Get-V2024ScheduledSearch # Below is a request that includes all optional parameters - # Get-V2024ScheduledSearch -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + # Get-V2024ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## unsubscribe-scheduled-search Unsubscribes a recipient from the specified scheduled search. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/unsubscribe-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -269,20 +284,23 @@ $TypedReference = @"{ try { $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-V2024UnsubscribeScheduledSearch -V2024Id $Id -V2024TypedReference $Result + Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result # Below is a request that includes all optional parameters - # Invoke-V2024UnsubscribeScheduledSearch -V2024Id $Id -V2024TypedReference $TypedReference + # Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-scheduled-search Updates an existing scheduled search. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -406,10 +424,10 @@ $ScheduledSearch = @"{ try { $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-V2024ScheduledSearch -V2024Id $Id -V2024ScheduledSearch $Result + Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result # Below is a request that includes all optional parameters - # Update-V2024ScheduledSearch -V2024Id $Id -V2024ScheduledSearch $ScheduledSearch + # Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md index f984446f8..3a6ef1d3d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md @@ -45,9 +45,12 @@ Method | HTTP request | Description [**Search-V2024Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID [**Search-V2024Post**](#search-post) | **POST** `/search` | Perform Search + ## search-aggregate Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-aggregate) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -200,19 +203,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon try { $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Aggregate -V2024Search $Result + Search-V2024Aggregate -V2024Search $Result # Below is a request that includes all optional parameters - # Search-V2024Aggregate -V2024Search $Search -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Search-V2024Aggregate -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-count Performs a search with a provided query and returns the count of results in the X-Total-Count header. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-count) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -359,19 +365,22 @@ $Search = @"{ try { $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Count -V2024Search $Result + Search-V2024Count -V2024Search $Result # Below is a request that includes all optional parameters - # Search-V2024Count -V2024Search $Search + # Search-V2024Count -V2024Search $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-get Fetches a single document from the specified index, using the specified document ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-get) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -379,12 +388,12 @@ Path | Index | **String** | True | The index from which to fetch the specifie Path | Id | **String** | True | ID of the requested document. ### Return type -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) +[**SearchDocument**](../models/search-document) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | The requested document. | SystemCollectionsHashtable +200 | The requested document. | SearchDocument 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,19 +413,22 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document # Get a Document by ID try { - Search-V2024Get -V2024Index $Index -V2024Id $Id + Search-V2024Get -Index $Index -Id $Id # Below is a request that includes all optional parameters - # Search-V2024Get -V2024Index $Index -V2024Id $Id + # Search-V2024Get -Index $Index -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-post Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/search-post) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -426,12 +438,12 @@ Param Type | Name | Data Type | Required | Description 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 -[**SystemCollectionsHashtable[]**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) +[**SearchDocument[]**](../models/search-document) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of matching documents. | SystemCollectionsHashtable[] +200 | List of matching documents. | SearchDocument[] 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 @@ -569,10 +581,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon try { $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Post -V2024Search $Result + Search-V2024Post -V2024Search $Result # Below is a request that includes all optional parameters - # Search-V2024Post -V2024Search $Search -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Search-V2024Post -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md index b524df53d..a5e40acf4 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md @@ -41,9 +41,12 @@ Method | HTTP request | Description [**Get-V2024SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute [**Update-V2024SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + ## create-search-attribute-config Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -82,19 +85,22 @@ $SearchAttributeConfig = @"{ try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result + New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result # Below is a request that includes all optional parameters - # New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $SearchAttributeConfig + # New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-search-attribute-config Delete an extended attribute configuration by name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -125,19 +131,22 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf # Delete Extended Search Attribute try { - Remove-V2024SearchAttributeConfig -V2024Name $Name + Remove-V2024SearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Remove-V2024SearchAttributeConfig -V2024Name $Name + # Remove-V2024SearchAttributeConfig -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-search-attribute-config Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -165,7 +174,7 @@ Code | Description | Data Type # List Extended Search Attributes try { - Get-V2024SearchAttributeConfig + Get-V2024SearchAttributeConfig # Below is a request that includes all optional parameters # Get-V2024SearchAttributeConfig @@ -175,9 +184,12 @@ try { } ``` [[Back to top]](#) + ## get-single-search-attribute-config Get an extended attribute configuration by name. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-single-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -209,21 +221,24 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute conf # Get Extended Search Attribute try { - Get-V2024SingleSearchAttributeConfig -V2024Name $Name + Get-V2024SingleSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Get-V2024SingleSearchAttributeConfig -V2024Name $Name + # Get-V2024SingleSearchAttributeConfig -Name $Name } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-search-attribute-config Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -262,10 +277,10 @@ $Name = "promotedMailAttribute" # String | Name of the search attribute configur try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SearchAttributeConfig -V2024Name $Name -V2024JsonPatchOperation $Result + Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SearchAttributeConfig -V2024Name $Name -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md index 82e129b81..516ff41e0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md @@ -40,10 +40,13 @@ Method | HTTP request | Description [**Get-V2024Segments**](#list-segments) | **GET** `/segments` | List Segments [**Update-V2024Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment + ## create-segment This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -97,20 +100,23 @@ $Segment = @"{ try { $Result = ConvertFrom-JsonToSegment -Json $Segment - New-V2024Segment -V2024Segment $Result + New-V2024Segment -V2024Segment $Result # Below is a request that includes all optional parameters - # New-V2024Segment -V2024Segment $Segment + # New-V2024Segment -V2024Segment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-segment This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -141,19 +147,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. # Delete Segment by ID try { - Remove-V2024Segment -V2024Id $Id + Remove-V2024Segment -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024Segment -V2024Id $Id + # Remove-V2024Segment -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-segment This API returns the segment specified by the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -184,19 +193,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. # Get Segment by ID try { - Get-V2024Segment -V2024Id $Id + Get-V2024Segment -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Segment -V2024Id $Id + # Get-V2024Segment -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-segments This API returns a list of all segments. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-segments) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -230,20 +242,23 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List Segments try { - Get-V2024Segments + Get-V2024Segments # Below is a request that includes all optional parameters - # Get-V2024Segments -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024Segments -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-segment Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -279,10 +294,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024Segment -V2024Id $Id -V2024RequestBody $Result + Update-V2024Segment -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Update-V2024Segment -V2024Id $Id -V2024RequestBody $RequestBody + # Update-V2024Segment -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md index 1c78225ee..1e1056db4 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md @@ -52,9 +52,12 @@ Method | HTTP request | Description [**Send-V2024ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration [**Update-V2024StatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + ## create-service-desk-integration Create a new Service Desk integration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -119,19 +122,22 @@ $ServiceDeskIntegrationDto = @"{ try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result + New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + # New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-service-desk-integration Delete an existing Service Desk integration by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -162,19 +168,22 @@ $Id = "anId" # String | ID of Service Desk integration to delete # Delete a Service Desk integration try { - Remove-V2024ServiceDeskIntegration -V2024Id $Id + Remove-V2024ServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024ServiceDeskIntegration -V2024Id $Id + # Remove-V2024ServiceDeskIntegration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-service-desk-integration Get an existing Service Desk integration by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -205,19 +214,22 @@ $Id = "anId" # String | ID of the Service Desk integration to get # Get a Service Desk integration try { - Get-V2024ServiceDeskIntegration -V2024Id $Id + Get-V2024ServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegration -V2024Id $Id + # Get-V2024ServiceDeskIntegration -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-service-desk-integration-template This API endpoint returns an existing Service Desk integration template by scriptName. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -248,19 +260,22 @@ $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk # Service Desk integration template by scriptName try { - Get-V2024ServiceDeskIntegrationTemplate -V2024ScriptName $ScriptName + Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegrationTemplate -V2024ScriptName $ScriptName + # Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-service-desk-integration-types This API endpoint returns the current list of supported Service Desk integration types. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integration-types) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -289,7 +304,7 @@ Code | Description | Data Type # List Service Desk integration types try { - Get-V2024ServiceDeskIntegrationTypes + Get-V2024ServiceDeskIntegrationTypes # Below is a request that includes all optional parameters # Get-V2024ServiceDeskIntegrationTypes @@ -299,9 +314,12 @@ try { } ``` [[Back to top]](#) + ## get-service-desk-integrations Get a list of Service Desk integration objects. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-service-desk-integrations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -340,19 +358,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List existing Service Desk integrations try { - Get-V2024ServiceDeskIntegrations + Get-V2024ServiceDeskIntegrations # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegrations -V2024Offset $Offset -V2024Limit $Limit -V2024Sorters $Sorters -V2024Filters $Filters -V2024Count $Count + # Get-V2024ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-status-check-details Get the time check configuration of queued SDIM tickets. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-status-check-details) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -381,7 +402,7 @@ Code | Description | Data Type # Get the time check configuration try { - Get-V2024StatusCheckDetails + Get-V2024StatusCheckDetails # Below is a request that includes all optional parameters # Get-V2024StatusCheckDetails @@ -391,9 +412,12 @@ try { } ``` [[Back to top]](#) + ## patch-service-desk-integration Update an existing Service Desk integration by ID with a PATCH request. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -427,19 +451,22 @@ $PatchServiceDeskIntegrationRequest = @""@ try { $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2024ServiceDeskIntegration -V2024Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result # Below is a request that includes all optional parameters - # Update-V2024ServiceDeskIntegration -V2024Id $Id -V2024PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest + # Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-service-desk-integration Update an existing Service Desk integration by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -506,19 +533,22 @@ $ServiceDeskIntegrationDto = @"{ try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-V2024ServiceDeskIntegration -V2024Id $Id -V2024ServiceDeskIntegrationDto $Result + Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Send-V2024ServiceDeskIntegration -V2024Id $Id -V2024ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + # Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-status-check-details Update the time check configuration of queued SDIM tickets. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-status-check-details) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -553,10 +583,10 @@ $QueuedCheckConfigDetails = @"{ try { $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result + Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result # Below is a request that includes all optional parameters - # Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $QueuedCheckConfigDetails + # Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourceUsagesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourceUsagesApi.md index f7dfe96e5..0a396c695 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourceUsagesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourceUsagesApi.md @@ -23,9 +23,12 @@ Method | HTTP request | Description [**Get-V2024StatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage [**Get-V2024UsagesBySourceId**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights + ## get-status-by-source-id This API returns the status of the source usage insights setup by IDN source ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-status-by-source-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -55,19 +58,22 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source # Finds status of source usage try { - Get-V2024StatusBySourceId -V2024SourceId $SourceId + Get-V2024StatusBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024StatusBySourceId -V2024SourceId $SourceId + # Get-V2024StatusBySourceId -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-usages-by-source-id This API returns a summary of source usage insights for past 12 months. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-usages-by-source-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -105,10 +111,10 @@ $Sorters = "-date" # String | Sort results using the standard syntax described i # Returns source usage insights try { - Get-V2024UsagesBySourceId -V2024SourceId $SourceId + Get-V2024UsagesBySourceId -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024UsagesBySourceId -V2024SourceId $SourceId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md index a9301a4ba..00019a8a0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md @@ -124,11 +124,14 @@ Method | HTTP request | Description [**Update-V2024SourceSchedule**](#update-source-schedule) | **PATCH** `/sources/{sourceId}/schedules/{scheduleType}` | Update Source Schedule (Partial) [**Update-V2024SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + ## create-provisioning-policy This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -201,19 +204,22 @@ $ProvisioningPolicyDto = @"{ try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024ProvisioningPolicyDto $Result + New-V2024ProvisioningPolicy -SourceId $SourceId -V2024ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # New-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024ProvisioningPolicyDto $ProvisioningPolicyDto + # New-V2024ProvisioningPolicy -SourceId $SourceId -V2024ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-source This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -328,20 +334,23 @@ $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures try { $Result = ConvertFrom-JsonToSource -Json $Source - New-V2024Source -V2024Source $Result + New-V2024Source -V2024Source $Result # Below is a request that includes all optional parameters - # New-V2024Source -V2024Source $Source -V2024ProvisionAsCsv $ProvisionAsCsv + # New-V2024Source -V2024Source $Result -ProvisionAsCsv $ProvisionAsCsv } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Source" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-source-schedule Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -374,20 +383,23 @@ $Schedule1 = @""@ try { $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 - New-V2024SourceSchedule -V2024SourceId $SourceId -V2024Schedule1 $Result + New-V2024SourceSchedule -SourceId $SourceId -V2024Schedule1 $Result # Below is a request that includes all optional parameters - # New-V2024SourceSchedule -V2024SourceId $SourceId -V2024Schedule1 $Schedule1 + # New-V2024SourceSchedule -SourceId $SourceId -V2024Schedule1 $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-source-schema Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -453,17 +465,21 @@ $Schema = @"{ try { $Result = ConvertFrom-JsonToSchema -Json $Schema - New-V2024SourceSchema -V2024SourceId $SourceId -V2024Schema $Result + New-V2024SourceSchema -SourceId $SourceId -V2024Schema $Result # Below is a request that includes all optional parameters - # New-V2024SourceSchema -V2024SourceId $SourceId -V2024Schema $Schema + # New-V2024SourceSchema -SourceId $SourceId -V2024Schema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-accounts-async +:::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. +::: Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. This endpoint is good for: @@ -472,6 +488,8 @@ This endpoint is good for: * Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-accounts-async) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -503,19 +521,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Remove All Accounts in a Source try { - Remove-V2024AccountsAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024AccountsAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountsAsync" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-native-change-detection-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. +::: Deletes the native change detection configuration for the source specified by the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-native-change-detection-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -548,19 +572,22 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Delete Native Change Detection Configuration try { - Remove-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NativeChangeDetectionConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-provisioning-policy Deletes the provisioning policy with the specified usage on an application. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -593,20 +620,23 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I # Delete Provisioning Policy by UsageType try { - Remove-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType + Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType # Below is a request that includes all optional parameters - # Remove-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType + # Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-source Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -637,19 +667,22 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. # Delete Source by ID try { - Remove-V2024Source -V2024Id $Id + Remove-V2024Source -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024Source -V2024Id $Id + # Remove-V2024Source -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Source" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-source-schedule +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -682,19 +715,22 @@ $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. # Delete Source Schedule by type. try { - Remove-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType # Below is a request that includes all optional parameters - # Remove-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + # Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-source-schema +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -727,20 +763,23 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. # Delete Source Schema by ID try { - Remove-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId + Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId # Below is a request that includes all optional parameters - # Remove-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId + # Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-accounts-schema This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-accounts-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -771,19 +810,22 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id # Downloads source accounts schema template try { - Get-V2024AccountsSchema -V2024Id $Id + Get-V2024AccountsSchema -Id $Id # Below is a request that includes all optional parameters - # Get-V2024AccountsSchema -V2024Id $Id + # Get-V2024AccountsSchema -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountsSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-correlation-config This API returns the existing correlation configuration for a source specified by the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-correlation-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -814,21 +856,24 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id # Get Source Correlation Configuration try { - Get-V2024CorrelationConfig -V2024Id $Id + Get-V2024CorrelationConfig -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CorrelationConfig -V2024Id $Id + # Get-V2024CorrelationConfig -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CorrelationConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-entitlements-schema This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-entitlements-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -861,19 +906,25 @@ $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optiona # Downloads source entitlements schema template try { - Get-V2024EntitlementsSchema -V2024Id $Id + Get-V2024EntitlementsSchema -Id $Id # Below is a request that includes all optional parameters - # Get-V2024EntitlementsSchema -V2024Id $Id -V2024SchemaName $SchemaName + # Get-V2024EntitlementsSchema -Id $Id -SchemaName $SchemaName } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-native-change-detection-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. +::: This API returns the existing native change detection configuration for a source specified by the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-native-change-detection-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -906,19 +957,22 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Native Change Detection Configuration try { - Get-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NativeChangeDetectionConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-provisioning-policy This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -951,19 +1005,22 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I # Get Provisioning Policy by UsageType try { - Get-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType + Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType # Below is a request that includes all optional parameters - # Get-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType + # Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source Use this API to get a source by a specified ID in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -994,19 +1051,25 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. # Get Source by ID try { - Get-V2024Source -V2024Id $Id + Get-V2024Source -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Source -V2024Id $Id + # Get-V2024Source -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Source" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-attr-sync-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. +::: This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-attr-sync-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1039,19 +1102,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Attribute Sync Config try { - Get-V2024SourceAttrSyncConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SourceAttrSyncConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceAttrSyncConfig" Write-Host $_.ErrorDetails } ``` [[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) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1085,23 +1154,29 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale # Gets source config with language translations try { - Get-V2024SourceConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SourceConfig -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SourceConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale + # Get-V2024SourceConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -Locale $Locale } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConfig" 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. +::: This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-entitlement-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1131,19 +1206,22 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Source Entitlement Request Configuration try { - Get-V2024SourceEntitlementRequestConfig -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SourceEntitlementRequestConfig -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-health This endpoint fetches source health by source's id +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-health) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1174,20 +1252,23 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. # Fetches source health by id try { - Get-V2024SourceHealth -V2024SourceId $SourceId + Get-V2024SourceHealth -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024SourceHealth -V2024SourceId $SourceId + # Get-V2024SourceHealth -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceHealth" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-schedule Get the source schedule by type in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1220,19 +1301,22 @@ $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. # Get Source Schedule by Type try { - Get-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType # Below is a request that includes all optional parameters - # Get-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + # Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-schedules Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schedules) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1263,20 +1347,23 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. # List Schedules on Source try { - Get-V2024SourceSchedules -V2024SourceId $SourceId + Get-V2024SourceSchedules -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024SourceSchedules -V2024SourceId $SourceId + # Get-V2024SourceSchedules -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedules" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-schema Get the Source Schema by ID in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1309,19 +1396,22 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. # Get Source Schema by ID try { - Get-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId + Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId # Below is a request that includes all optional parameters - # Get-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId + # Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-source-schemas Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schemas) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1356,21 +1446,27 @@ $IncludeNames = "account" # String | A comma-separated list of schema names to f # List Schemas on Source try { - Get-V2024SourceSchemas -V2024SourceId $SourceId + Get-V2024SourceSchemas -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024SourceSchemas -V2024SourceId $SourceId -V2024IncludeTypes $IncludeTypes -V2024IncludeNames $IncludeNames + # Get-V2024SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchemas" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-accounts +:::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. +::: Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-accounts) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1406,16 +1502,17 @@ $DisableOptimization = "MyDisableOptimization" # String | Use this flag to repro # Account Aggregation try { - Import-V2024Accounts -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Import-V2024Accounts -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File -V2024DisableOptimization $DisableOptimization + # Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Accounts" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-accounts-schema This API uploads a source schema template file to configure a source's account attributes. @@ -1425,6 +1522,8 @@ Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Imp >**NOTE: This API is designated only for Delimited File sources.** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-accounts-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1456,19 +1555,22 @@ $File = # System.IO.FileInfo | (optional) # Uploads source accounts schema template try { - Import-V2024AccountsSchema -V2024Id $Id + Import-V2024AccountsSchema -Id $Id # Below is a request that includes all optional parameters - # Import-V2024AccountsSchema -V2024Id $Id -V2024File $File + # Import-V2024AccountsSchema -Id $Id -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024AccountsSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-connector-file This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-connector-file) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1500,16 +1602,17 @@ $File = # System.IO.FileInfo | (optional) # Upload connector file to source try { - Import-V2024ConnectorFile -V2024SourceId $SourceId + Import-V2024ConnectorFile -SourceId $SourceId # Below is a request that includes all optional parameters - # Import-V2024ConnectorFile -V2024SourceId $SourceId -V2024File $File + # Import-V2024ConnectorFile -SourceId $SourceId -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024ConnectorFile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-entitlements-schema This API uploads a source schema template file to configure a source's entitlement attributes. @@ -1519,6 +1622,8 @@ Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Imp >**NOTE: This API is designated only for Delimited File sources.** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-entitlements-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1552,19 +1657,25 @@ $File = # System.IO.FileInfo | (optional) # Uploads source entitlements schema template try { - Import-V2024EntitlementsSchema -V2024Id $Id + Import-V2024EntitlementsSchema -Id $Id # Below is a request that includes all optional parameters - # Import-V2024EntitlementsSchema -V2024Id $Id -V2024SchemaName $SchemaName -V2024File $File + # Import-V2024EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## import-uncorrelated-accounts +:::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. +::: File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-uncorrelated-accounts) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1598,19 +1709,22 @@ $File = # System.IO.FileInfo | (optional) # Process Uncorrelated Accounts try { - Import-V2024UncorrelatedAccounts -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Import-V2024UncorrelatedAccounts -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File + # Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024UncorrelatedAccounts" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-provisioning-policies This end-point lists all the ProvisioningPolicies in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-provisioning-policies) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1641,19 +1755,22 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id # Lists ProvisioningPolicies try { - Get-V2024ProvisioningPolicies -V2024SourceId $SourceId + Get-V2024ProvisioningPolicies -SourceId $SourceId # Below is a request that includes all optional parameters - # Get-V2024ProvisioningPolicies -V2024SourceId $SourceId + # Get-V2024ProvisioningPolicies -SourceId $SourceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicies" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-sources This end-point lists all the sources in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sources) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1696,19 +1813,25 @@ $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the resp # Lists all sources in IdentityNow. try { - Get-V2024Sources + Get-V2024Sources # Below is a request that includes all optional parameters - # Get-V2024Sources -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSubadmin $ForSubadmin -V2024IncludeIDNSource $IncludeIDNSource + # Get-V2024Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Sources" Write-Host $_.ErrorDetails } ``` [[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 ------------- | ------------- | ------------- | ------------- | ------------- @@ -1747,19 +1870,25 @@ $ResourceObjectsRequest = @"{ try { $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest - Receive-V2024ResourceObjects -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $Result + Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $Result # Below is a request that includes all optional parameters - # Receive-V2024ResourceObjects -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $ResourceObjectsRequest + # Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $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) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1792,19 +1921,22 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Ping cluster for source connector try { - Ping-V2024Cluster -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + Ping-V2024Cluster -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Ping-V2024Cluster -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + # Ping-V2024Cluster -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2024Cluster" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-correlation-config Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-correlation-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1858,19 +1990,25 @@ $CorrelationConfig = @"{ try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig - Send-V2024CorrelationConfig -V2024Id $Id -V2024CorrelationConfig $Result + Send-V2024CorrelationConfig -Id $Id -V2024CorrelationConfig $Result # Below is a request that includes all optional parameters - # Send-V2024CorrelationConfig -V2024Id $Id -V2024CorrelationConfig $CorrelationConfig + # Send-V2024CorrelationConfig -Id $Id -V2024CorrelationConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024CorrelationConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-native-change-detection-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. +::: Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-native-change-detection-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1913,21 +2051,24 @@ $NativeChangeDetectionConfig = @"{ try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig - Send-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $Result + Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $Result # Below is a request that includes all optional parameters - # Send-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $NativeChangeDetectionConfig + # Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-provisioning-policy This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2002,16 +2143,17 @@ $ProvisioningPolicyDto = @"{ try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType -V2024ProvisioningPolicyDto $Result + Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Send-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType -V2024ProvisioningPolicyDto $ProvisioningPolicyDto + # Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-source Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. @@ -2027,6 +2169,8 @@ These fields are immutable, so they cannot be changed: Attempts to modify these fields will result in a 400 error. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2142,20 +2286,26 @@ $Source = @"{ try { $Result = ConvertFrom-JsonToSource -Json $Source - Send-V2024Source -V2024Id $Id -V2024Source $Result + Send-V2024Source -Id $Id -V2024Source $Result # Below is a request that includes all optional parameters - # Send-V2024Source -V2024Id $Id -V2024Source $Source + # Send-V2024Source -Id $Id -V2024Source $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Source" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-source-attr-sync-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. +::: Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-source-attr-sync-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2208,16 +2358,17 @@ $AttrSyncSourceConfig = @"{ try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig - Send-V2024SourceAttrSyncConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $Result + Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $Result # Below is a request that includes all optional parameters - # Send-V2024SourceAttrSyncConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $AttrSyncSourceConfig + # Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceAttrSyncConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-source-schema This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. @@ -2231,6 +2382,8 @@ Any attempt to modify these fields will result in an error response with a statu > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2299,19 +2452,25 @@ $Schema = @"{ try { $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024Schema $Result + Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024Schema $Result # Below is a request that includes all optional parameters - # Send-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024Schema $Schema + # Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024Schema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema" 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. +::: This end-point performs attribute synchronization for a selected source. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/sync-attributes-for-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2344,19 +2503,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Synchronize single source attributes. try { - Sync-V2024AttributesForSource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Sync-V2024AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Sync-V2024AttributesForSource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Sync-V2024AttributesForSource -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024AttributesForSource" Write-Host $_.ErrorDetails } ``` [[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) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2389,19 +2554,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Test configuration for source connector try { - Test-V2024SourceConfiguration -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + Test-V2024SourceConfiguration -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Test-V2024SourceConfiguration -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + # Test-V2024SourceConfiguration -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConfiguration" Write-Host $_.ErrorDetails } ``` [[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) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2434,21 +2605,24 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Check connection for source connector. try { - Test-V2024SourceConnection -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + Test-V2024SourceConnection -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Test-V2024SourceConnection -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + # Test-V2024SourceConnection -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnection" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-password-policy-holders This API can be used to set up or update Password Policy in IdentityNow for the specified Source. Source must support PASSWORD feature. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-password-policy-holders) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2483,19 +2657,22 @@ $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id try { $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner - Update-V2024PasswordPolicyHolders -V2024SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $Result + Update-V2024PasswordPolicyHolders -SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $Result # Below is a request that includes all optional parameters - # Update-V2024PasswordPolicyHolders -V2024SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $PasswordPolicyHoldersDtoInner + # Update-V2024PasswordPolicyHolders -SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordPolicyHolders" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-provisioning-policies-in-bulk This end-point updates a list of provisioning policies on the specified source in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-provisioning-policies-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2569,21 +2746,24 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-V2024ProvisioningPoliciesInBulk -V2024SourceId $SourceId -V2024ProvisioningPolicyDto $Result + Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPoliciesInBulk -V2024SourceId $SourceId -V2024ProvisioningPolicyDto $ProvisioningPolicyDto + # Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-provisioning-policy This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2624,16 +2804,17 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType -V2024JsonPatchOperation $Result + Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-source Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -2652,6 +2833,8 @@ These fields are immutable, so they cannot be changed: Attempts to modify these fields will result in a 400 error. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2690,23 +2873,29 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Source -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Source -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-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. +::: This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-entitlement-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2751,16 +2940,17 @@ $SourceEntitlementRequestConfig = @"{ try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-V2024SourceEntitlementRequestConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result + Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result # Below is a request that includes all optional parameters - # Update-V2024SourceEntitlementRequestConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $SourceEntitlementRequestConfig + # Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-source-schedule Use this API to selectively update an existing Schedule using a JSONPatch payload. @@ -2769,6 +2959,8 @@ The following schedule fields are immutable and cannot be updated: - type +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2809,16 +3001,17 @@ $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType -V2024JsonPatchOperation $Result + Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-source-schema Use this API to selectively update an existing Schema using a JSONPatch payload. @@ -2851,6 +3044,8 @@ To switch an account attribute to a group entitlement, you need to have the foll ``` +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -2891,10 +3086,10 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024JsonPatchOperation $Result + Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md index 6d1bef255..2d0bafe47 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md @@ -28,13 +28,19 @@ Method | HTTP request | Description [**Submit-V2024SedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request [**Submit-V2024SedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request + ## get-sed-batch-stats +:::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. +::: 'Submit Sed Batch Stats Request. Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats of the batchId.' +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batch-stats) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -67,20 +73,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Submit Sed Batch Stats Request try { - Get-V2024SedBatchStats -V2024BatchId $BatchId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SedBatchStats -V2024BatchId $BatchId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-sed-batches +:::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. +::: List Sed Batches. API responses with Sed Batch Status +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batches) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -111,17 +123,21 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # List Sed Batch Request try { - Get-V2024SedBatches -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SedBatches -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-seds +:::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. +::: List of Suggested Entitlement Descriptions (SED) SED field descriptions: @@ -138,6 +154,8 @@ SED field descriptions: **fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-seds) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -182,19 +200,25 @@ $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are # List Suggested Entitlement Descriptions try { - Get-V2024Seds -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Seds -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Seds -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters -V2024Count $Count -V2024CountOnly $CountOnly -V2024RequestedByAnyone $RequestedByAnyone -V2024ShowPendingStatusOnly $ShowPendingStatusOnly + # Get-V2024Seds -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Sorters $Sorters -Count $Count -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $ShowPendingStatusOnly } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-sed +:::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. +::: Patch Suggested Entitlement Description +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-sed) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -235,20 +259,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-V2024Sed -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result + Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result # Below is a request that includes all optional parameters - # Update-V2024Sed -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SedPatch $SedPatch + # Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-sed-approval +:::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. +::: Submit Bulk Approval Request for SED. Request body takes list of SED Ids. API responses with list of SED Approval Status +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-approval) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -285,20 +315,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-V2024SedApproval -V2024XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result + Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result # Below is a request that includes all optional parameters - # Submit-V2024SedApproval -V2024XSailPointExperimental $XSailPointExperimental -V2024SedApproval $SedApproval + # Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-sed-assignment +:::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. +::: Submit Assignment Request. Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-assignment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -338,20 +374,26 @@ $SedAssignment = @"{ try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-V2024SedAssignment -V2024XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result + Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result # Below is a request that includes all optional parameters - # Submit-V2024SedAssignment -V2024XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $SedAssignment + # Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-sed-batch-request +:::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. +::: Submit Sed Batch Request. Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-sed-batch-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -387,10 +429,10 @@ $SedBatchRequest = @"{ # Submit Sed Batch Request try { - Submit-V2024SedBatchRequest -V2024XSailPointExperimental $XSailPointExperimental + Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Submit-V2024SedBatchRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024SedBatchRequest $SedBatchRequest + # Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental -V2024SedBatchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md index 5ce227322..5902ee193 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md @@ -79,9 +79,12 @@ Method | HTTP request | Description [**Set-V2024TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object [**Set-V2024TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects + ## delete-tagged-object Delete all tags from a tagged object. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tagged-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -113,19 +116,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to dele # Delete Object Tags try { - Remove-V2024TaggedObject -V2024Type $Type -V2024Id $Id + Remove-V2024TaggedObject -Type $Type -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024TaggedObject -V2024Type $Type -V2024Id $Id + # Remove-V2024TaggedObject -Type $Type -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TaggedObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-tags-to-many-object This API removes tags from multiple objects. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-tags-to-many-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -167,19 +173,22 @@ $BulkRemoveTaggedObject = @"{ try { $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject - Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result + Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result # Below is a request that includes all optional parameters - # Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $BulkRemoveTaggedObject + # Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-tagged-object This gets a tagged object for the specified type. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tagged-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -211,21 +220,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen # Get Tagged Object try { - Get-V2024TaggedObject -V2024Type $Type -V2024Id $Id + Get-V2024TaggedObject -Type $Type -Id $Id # Below is a request that includes all optional parameters - # Get-V2024TaggedObject -V2024Type $Type -V2024Id $Id + # Get-V2024TaggedObject -Type $Type -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-tagged-objects This API returns a list of all tagged objects. Any authenticated token may be used to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-tagged-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -261,21 +273,24 @@ $Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standar # List Tagged Objects try { - Get-V2024TaggedObjects + Get-V2024TaggedObjects # Below is a request that includes all optional parameters - # Get-V2024TaggedObjects -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + # Get-V2024TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjects" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-tagged-objects-by-type This API returns a list of all tagged objects by type. Any authenticated token may be used to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-tagged-objects-by-type) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -313,19 +328,22 @@ $Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filte # List Tagged Objects by Type try { - Get-V2024TaggedObjectsByType -V2024Type $Type + Get-V2024TaggedObjectsByType -Type $Type # Below is a request that includes all optional parameters - # Get-V2024TaggedObjectsByType -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + # Get-V2024TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjectsByType" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-tagged-object This updates a tagged object for the specified type. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-tagged-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -367,21 +385,24 @@ $TaggedObject = @"{ try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-V2024TaggedObject -V2024Type $Type -V2024Id $Id -V2024TaggedObject $Result + Send-V2024TaggedObject -Type $Type -Id $Id -V2024TaggedObject $Result # Below is a request that includes all optional parameters - # Send-V2024TaggedObject -V2024Type $Type -V2024Id $Id -V2024TaggedObject $TaggedObject + # Send-V2024TaggedObject -Type $Type -Id $Id -V2024TaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-tag-to-object This adds a tag to an object. Any authenticated token may be used to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tag-to-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -419,19 +440,22 @@ $TaggedObject = @"{ try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-V2024TagToObject -V2024TaggedObject $Result + Set-V2024TagToObject -V2024TaggedObject $Result # Below is a request that includes all optional parameters - # Set-V2024TagToObject -V2024TaggedObject $TaggedObject + # Set-V2024TagToObject -V2024TaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-tags-to-many-objects This API adds tags to multiple objects. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tags-to-many-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -474,10 +498,10 @@ $BulkAddTaggedObject = @"{ try { $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject - Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result + Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result # Below is a request that includes all optional parameters - # Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $BulkAddTaggedObject + # Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md index b8d7cd8f0..d7ec678a6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md @@ -23,9 +23,15 @@ Method | HTTP request | Description [**Get-V2024TaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List [**Update-V2024TaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID + ## get-pending-task-headers +:::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. +::: Responds with headers only for list of task statuses for pending tasks. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-task-headers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -62,19 +68,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieve Pending Task List Headers try { - Get-V2024PendingTaskHeaders -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PendingTaskHeaders -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-pending-tasks +:::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. +::: Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -111,19 +123,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Retrieve Pending Task Status List try { - Get-V2024PendingTasks -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024PendingTasks -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + # Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-task-status +:::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. +::: Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-task-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -156,20 +174,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Task Status by ID try { - Get-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-task-status-list +:::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. +::: Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-task-status-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -210,19 +234,25 @@ $Sorters = "-created" # String | Sort results using the standard syntax describe # Retrieve Task Status List try { - Get-V2024TaskStatusList -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024TaskStatusList -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-task-status +:::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. +::: Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-task-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -263,10 +293,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md index 7c2e4a1a4..1a7dbdbbc 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md @@ -19,9 +19,15 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-V2024Tenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information. + ## get-tenant +:::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 rest endpoint can be used to retrieve tenant details. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -52,10 +58,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Tenant Information. try { - Get-V2024Tenant -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Tenant -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md index 0950b8b18..4b2462b49 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md @@ -29,9 +29,12 @@ Method | HTTP request | Description [**Get-V2024Transforms**](#list-transforms) | **GET** `/transforms` | List transforms [**Update-V2024Transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform + ## create-transform Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -83,19 +86,22 @@ $Transform = @"{ try { $Result = ConvertFrom-JsonToTransform -Json $Transform - New-V2024Transform -V2024Transform $Result + New-V2024Transform -V2024Transform $Result # Below is a request that includes all optional parameters - # New-V2024Transform -V2024Transform $Transform + # New-V2024Transform -V2024Transform $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-transform Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -126,19 +132,22 @@ $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete # Delete a transform try { - Remove-V2024Transform -V2024Id $Id + Remove-V2024Transform -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024Transform -V2024Id $Id + # Remove-V2024Transform -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Transform" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-transform This API returns the transform specified by the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -169,19 +178,22 @@ $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retriev # Transform by ID try { - Get-V2024Transform -V2024Id $Id + Get-V2024Transform -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Transform -V2024Id $Id + # Get-V2024Transform -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transform" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-transforms Gets a list of all saved transform objects. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-transforms) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -220,19 +232,22 @@ $Filters = 'name eq "Uppercase"' # String | Filter results using the standard sy # List transforms try { - Get-V2024Transforms + Get-V2024Transforms # Below is a request that includes all optional parameters - # Get-V2024Transforms -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Name $Name -V2024Filters $Filters + # Get-V2024Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transforms" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-transform Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -285,10 +300,10 @@ $Transform = @"{ # Update a transform try { - Update-V2024Transform -V2024Id $Id + Update-V2024Transform -Id $Id # Below is a request that includes all optional parameters - # Update-V2024Transform -V2024Id $Id -V2024Transform $Transform + # Update-V2024Transform -Id $Id -V2024Transform $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Transform" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md index 610ea8914..b10ab9dae 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md @@ -69,9 +69,15 @@ Method | HTTP request | Description [**Test-V2024SubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter [**Update-V2024Subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription + ## complete-trigger-invocation +:::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. +::: Completes an invocation to a REQUEST_RESPONSE type trigger. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-trigger-invocation) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -112,21 +118,27 @@ $CompleteInvocation = @"{ try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation - Complete-V2024TriggerInvocation -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result + Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result # Below is a request that includes all optional parameters - # Complete-V2024TriggerInvocation -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $CompleteInvocation + # Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-subscription +:::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 API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: * HTTP subscriptions require httpConfig * EventBridge subscriptions require eventBridgeConfig +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-subscription) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -183,19 +195,25 @@ $SubscriptionPostRequest = @"{ try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest - New-V2024Subscription -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result + New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result # Below is a request that includes all optional parameters - # New-V2024Subscription -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $SubscriptionPostRequest + # New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-subscription +:::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. +::: Deletes an existing subscription to a trigger. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-subscription) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -228,19 +246,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Delete a Subscription try { - Remove-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Subscription" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-subscriptions +:::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. +::: Gets a list of all trigger subscriptions. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-subscriptions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -280,21 +304,27 @@ $Sorters = "triggerName" # String | Sort results using the standard syntax descr # List Subscriptions try { - Get-V2024Subscriptions -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Subscriptions -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Subscriptions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-trigger-invocation-status +:::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. +::: Gets a list of latest invocation statuses. Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-trigger-invocation-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -334,19 +364,25 @@ $Sorters = "created" # String | Sort results using the standard syntax described # List Latest Invocation Statuses try { - Get-V2024TriggerInvocationStatus -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024TriggerInvocationStatus -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TriggerInvocationStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-triggers +:::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. +::: Gets a list of triggers that are available in the tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-triggers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -386,21 +422,27 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # List Triggers try { - Get-V2024Triggers -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Triggers -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + # Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Triggers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-subscription +:::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 API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: **name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-subscription) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -437,19 +479,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner - Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result + Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $SubscriptionPatchRequestInner + # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-test-trigger-invocation +:::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. +::: Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/start-test-trigger-invocation) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -492,20 +540,26 @@ $TestInvocation = @"{ try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation - Start-V2024TestTriggerInvocation -V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result + Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result # Below is a request that includes all optional parameters - # Start-V2024TestTriggerInvocation -V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $TestInvocation + # Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-subscription-filter +:::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. +::: Validates a JSONPath filter expression against a provided mock input. Request requires a security scope of: +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-subscription-filter) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -543,17 +597,21 @@ $ValidateFilterInputDto = @"{ try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto - Test-V2024SubscriptionFilter -V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result + Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result # Below is a request that includes all optional parameters - # Test-V2024SubscriptionFilter -V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $ValidateFilterInputDto + # Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-subscription +:::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 API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing Subscription is completely replaced. The following fields are immutable: @@ -565,6 +623,8 @@ This API updates a trigger subscription in IdentityNow, using a full object repr Attempts to modify these fields result in 400. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-subscription) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -623,10 +683,10 @@ $SubscriptionPutRequest = @"{ try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest - Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result + Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result # Below is a request that includes all optional parameters - # Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $SubscriptionPutRequest + # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md index 229da8581..70a356036 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md @@ -21,9 +21,15 @@ Method | HTTP request | Description [**Get-V2024TenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata [**Set-V2024TenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata + ## get-tenant-ui-metadata +:::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 API endpoint retrieves UI metadata configured for your tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-ui-metadata) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -54,19 +60,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get a tenant UI metadata try { - Get-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantUiMetadata" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-tenant-ui-metadata +:::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 API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-tenant-ui-metadata) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -104,10 +116,10 @@ $TenantUiMetadataItemUpdateRequest = @"{ try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest - Set-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result + Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result # Below is a request that includes all optional parameters - # Set-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest + # Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TenantUiMetadata" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md index 806faf94c..b5d658a6f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md @@ -25,10 +25,13 @@ Method | HTTP request | Description [**Remove-V2024VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping [**Get-V2024VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings + ## create-vendor-connector-mapping Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-vendor-connector-mapping) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -82,20 +85,23 @@ $VendorConnectorMapping = @"{ try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result + New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result # Below is a request that includes all optional parameters - # New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $VendorConnectorMapping + # New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-vendor-connector-mapping Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-vendor-connector-mapping) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -149,20 +155,23 @@ $VendorConnectorMapping = @"{ try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result + Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result # Below is a request that includes all optional parameters - # Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $VendorConnectorMapping + # Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-vendor-connector-mappings Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-vendor-connector-mappings) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -191,7 +200,7 @@ Code | Description | Data Type # List Vendor Connector Mappings try { - Get-V2024VendorConnectorMappings + Get-V2024VendorConnectorMappings # Below is a request that includes all optional parameters # Get-V2024VendorConnectorMappings diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md index ef783ff9e..f8a0a3836 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md @@ -45,9 +45,12 @@ Method | HTTP request | Description [**Send-V2024WorkItemForward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item [**Submit-V2024AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections + ## approve-approval-item This API approves an Approval Item. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-approval-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -80,19 +83,22 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap # Approve an Approval Item try { - Approve-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Approve-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + # Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## approve-approval-items-in-bulk This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/approve-approval-items-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -123,19 +129,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item # Bulk approve Approval Items try { - Approve-V2024ApprovalItemsInBulk -V2024Id $Id + Approve-V2024ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Approve-V2024ApprovalItemsInBulk -V2024Id $Id + # Approve-V2024ApprovalItemsInBulk -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## complete-work-item This API completes a work item. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/complete-work-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -166,19 +175,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item # Complete a Work Item try { - Complete-V2024WorkItem -V2024Id $Id + Complete-V2024WorkItem -Id $Id # Below is a request that includes all optional parameters - # Complete-V2024WorkItem -V2024Id $Id + # Complete-V2024WorkItem -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-completed-work-items This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-completed-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -214,19 +226,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Completed Work Items try { - Get-V2024CompletedWorkItems + Get-V2024CompletedWorkItems # Below is a request that includes all optional parameters - # Get-V2024CompletedWorkItems -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + # Get-V2024CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-count-completed-work-items This gets a count of completed work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-count-completed-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -256,19 +271,22 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own # Count Completed Work Items try { - Get-V2024CountCompletedWorkItems + Get-V2024CountCompletedWorkItems # Below is a request that includes all optional parameters - # Get-V2024CountCompletedWorkItems -V2024OwnerId $OwnerId + # Get-V2024CountCompletedWorkItems -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-count-work-items This gets a count of work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-count-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -298,19 +316,22 @@ $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item own # Count Work Items try { - Get-V2024CountWorkItems + Get-V2024CountWorkItems # Below is a request that includes all optional parameters - # Get-V2024CountWorkItems -V2024OwnerId $OwnerId + # Get-V2024CountWorkItems -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-work-item This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-work-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -340,19 +361,22 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. # Get a Work Item try { - Get-V2024WorkItem -V2024Id $Id + Get-V2024WorkItem -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkItem -V2024Id $Id + # Get-V2024WorkItem -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-work-items-summary This gets a summary of work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-work-items-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -382,19 +406,22 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own # Work Items Summary try { - Get-V2024WorkItemsSummary + Get-V2024WorkItemsSummary # Below is a request that includes all optional parameters - # Get-V2024WorkItemsSummary -V2024OwnerId $OwnerId + # Get-V2024WorkItemsSummary -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-work-items This gets a collection of work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -430,19 +457,22 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own # List Work Items try { - Get-V2024WorkItems + Get-V2024WorkItems # Below is a request that includes all optional parameters - # Get-V2024WorkItems -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024OwnerId $OwnerId + # Get-V2024WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reject-approval-item This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-approval-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -475,19 +505,22 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap # Reject an Approval Item try { - Deny-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Deny-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + # Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reject-approval-items-in-bulk This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/reject-approval-items-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -518,19 +551,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item # Bulk reject Approval Items try { - Deny-V2024ApprovalItemsInBulk -V2024Id $Id + Deny-V2024ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Deny-V2024ApprovalItemsInBulk -V2024Id $Id + # Deny-V2024ApprovalItemsInBulk -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-work-item-forward This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-work-item-forward) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -567,19 +603,22 @@ $WorkItemForward = @"{ try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-V2024WorkItemForward -V2024Id $Id -V2024WorkItemForward $Result + Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result # Below is a request that includes all optional parameters - # Send-V2024WorkItemForward -V2024Id $Id -V2024WorkItemForward $WorkItemForward + # Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-account-selection This API submits account selections. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/submit-account-selection) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -613,10 +652,10 @@ $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Sele try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-V2024AccountSelection -V2024Id $Id -V2024RequestBody $Result + Submit-V2024AccountSelection -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Submit-V2024AccountSelection -V2024Id $Id -V2024RequestBody $RequestBody + # Submit-V2024AccountSelection -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md index 6da1f69bb..454f88c2b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md @@ -37,9 +37,15 @@ Method | HTTP request | Description [**Send-V2024ReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration [**Send-V2024TenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings + ## create-reassignment-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. +::: Creates a new Reassignment Configuration for the specified identity. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-reassignment-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -78,19 +84,25 @@ $ConfigurationItemRequest = @"{ try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-V2024ReassignmentConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # New-V2024ReassignmentConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $ConfigurationItemRequest + # New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-reassignment-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. +::: Deletes a single reassignment configuration for the specified identity +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-reassignment-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -124,19 +136,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Delete Reassignment Configuration try { - Remove-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental + Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Remove-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental + # Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-evaluate-reassignment-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. +::: Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-evaluate-reassignment-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -174,19 +192,25 @@ $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # String[] | Exclusion filters th # Evaluate Reassignment Configuration try { - Get-V2024EvaluateReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024EvaluateReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental -V2024ExclusionFilters $ExclusionFilters + # Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-reassignment-config-types +:::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. +::: Gets a collection of types which are available in the Reassignment Configuration UI. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-reassignment-config-types) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -216,19 +240,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # List Reassignment Config Types try { - Get-V2024ReassignmentConfigTypes -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfigTypes -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-reassignment-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. +::: Gets the Reassignment Configuration for an identity. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-reassignment-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -261,19 +291,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Reassignment Configuration try { - Get-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-tenant-config-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. +::: Gets the global Reassignment Configuration settings for the requestor's tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-config-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -304,19 +340,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # Get Tenant-wide Reassignment Configuration settings try { - Get-V2024TenantConfigConfiguration -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024TenantConfigConfiguration -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-reassignment-configurations +:::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. +::: Gets all Reassignment configuration for the current org. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-reassignment-configurations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -347,19 +389,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper # List Reassignment Configurations try { - Get-V2024ReassignmentConfigurations -V2024XSailPointExperimental $XSailPointExperimental + Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfigurations -V2024XSailPointExperimental $XSailPointExperimental + # Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-reassignment-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. +::: Replaces existing Reassignment configuration for an identity with the newly provided configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-reassignment-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -400,19 +448,25 @@ $ConfigurationItemRequest = @"{ try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-V2024ReassignmentConfig -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Send-V2024ReassignmentConfig -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $ConfigurationItemRequest + # Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-tenant-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. +::: Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-tenant-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -449,10 +503,10 @@ $TenantConfigurationRequest = @"{ try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-V2024TenantConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result + Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result # Below is a request that includes all optional parameters - # Send-V2024TenantConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $TenantConfigurationRequest + # Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md index 3549e19c8..c27c90e91 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md @@ -37,9 +37,12 @@ Method | HTTP request | Description [**Test-V2024ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger [**Test-V2024Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id + ## cancel-workflow-execution Use this API to cancel a running workflow execution. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/cancel-workflow-execution) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -70,19 +73,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution I # Cancel Workflow Execution by ID try { - Suspend-V2024WorkflowExecution -V2024Id $Id + Suspend-V2024WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Suspend-V2024WorkflowExecution -V2024Id $Id + # Suspend-V2024WorkflowExecution -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-external-execute-workflow This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-external-execute-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -114,19 +120,22 @@ $CreateExternalExecuteWorkflowRequest = @""@ # Execute Workflow via External Trigger try { - New-V2024ExternalExecuteWorkflow -V2024Id $Id + New-V2024ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # New-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest + # New-V2024ExternalExecuteWorkflow -Id $Id -V2024CreateExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-workflow Create a new workflow with the desired trigger and steps specified in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,19 +166,22 @@ $CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568 try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2024Workflow -V2024CreateWorkflowRequest $Result + New-V2024Workflow -V2024CreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # New-V2024Workflow -V2024CreateWorkflowRequest $CreateWorkflowRequest + # New-V2024Workflow -V2024CreateWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-workflow-external-trigger Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-workflow-external-trigger) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -199,19 +211,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow # Generate External Trigger OAuth Client try { - New-V2024WorkflowExternalTrigger -V2024Id $Id + New-V2024WorkflowExternalTrigger -Id $Id # Below is a request that includes all optional parameters - # New-V2024WorkflowExternalTrigger -V2024Id $Id + # New-V2024WorkflowExternalTrigger -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-workflow Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -241,19 +256,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow # Delete Workflow By Id try { - Remove-V2024Workflow -V2024Id $Id + Remove-V2024Workflow -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024Workflow -V2024Id $Id + # Remove-V2024Workflow -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-workflow Get a single workflow by id. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -283,19 +301,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow # Get Workflow By Id try { - Get-V2024Workflow -V2024Id $Id + Get-V2024Workflow -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Workflow -V2024Id $Id + # Get-V2024Workflow -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-workflow-execution Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow-execution) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -326,19 +347,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. # Get Workflow Execution try { - Get-V2024WorkflowExecution -V2024Id $Id + Get-V2024WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecution -V2024Id $Id + # Get-V2024WorkflowExecution -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-workflow-execution-history Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow-execution-history) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -369,16 +393,17 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execu # Get Workflow Execution History try { - Get-V2024WorkflowExecutionHistory -V2024Id $Id + Get-V2024WorkflowExecutionHistory -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutionHistory -V2024Id $Id + # Get-V2024WorkflowExecutionHistory -Id $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-workflow-executions Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. @@ -392,6 +417,8 @@ Use this API to list a specified workflow's executions. Workflow executions are For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-workflow-executions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -430,19 +457,22 @@ $Filters = 'status eq "Failed"' # String | Filter results using the standard syn # List Workflow Executions try { - Get-V2024WorkflowExecutions -V2024Id $Id + Get-V2024WorkflowExecutions -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutions -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-complete-workflow-library This lists all triggers, actions, and operators in the library +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-complete-workflow-library) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -474,19 +504,22 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # List Complete Workflow Library try { - Get-V2024CompleteWorkflowLibrary + Get-V2024CompleteWorkflowLibrary # Below is a request that includes all optional parameters - # Get-V2024CompleteWorkflowLibrary -V2024Limit $Limit -V2024Offset $Offset + # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-workflow-library-actions This lists the workflow actions available to you. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-actions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -520,19 +553,22 @@ $Filters = 'id eq "sp:create-campaign"' # String | Filter results using the stan # List Workflow Library Actions try { - Get-V2024WorkflowLibraryActions + Get-V2024WorkflowLibraryActions # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryActions -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-workflow-library-operators This lists the workflow operators available to you +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-operators) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -560,7 +596,7 @@ Code | Description | Data Type # List Workflow Library Operators try { - Get-V2024WorkflowLibraryOperators + Get-V2024WorkflowLibraryOperators # Below is a request that includes all optional parameters # Get-V2024WorkflowLibraryOperators @@ -570,9 +606,12 @@ try { } ``` [[Back to top]](#) + ## list-workflow-library-triggers This lists the workflow triggers available to you +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflow-library-triggers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -606,19 +645,22 @@ $Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results u # List Workflow Library Triggers try { - Get-V2024WorkflowLibraryTriggers + Get-V2024WorkflowLibraryTriggers # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryTriggers -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-workflows List all workflows in the tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-workflows) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -646,7 +688,7 @@ Code | Description | Data Type # List Workflows try { - Get-V2024Workflows + Get-V2024Workflows # Below is a request that includes all optional parameters # Get-V2024Workflows @@ -656,9 +698,12 @@ try { } ``` [[Back to top]](#) + ## patch-workflow Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -696,19 +741,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Workflow -V2024Id $Id -V2024JsonPatchOperation $Result + Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Workflow -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + # Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-workflow Perform a full update of a workflow. The updated workflow object is returned in the response. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -779,19 +827,22 @@ $WorkflowBody = @"{ try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2024Workflow -V2024Id $Id -V2024WorkflowBody $Result + Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result # Below is a request that includes all optional parameters - # Send-V2024Workflow -V2024Id $Id -V2024WorkflowBody $WorkflowBody + # Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-external-execute-workflow Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-external-execute-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -823,21 +874,24 @@ $TestExternalExecuteWorkflowRequest = @""@ # Test Workflow via External Trigger try { - Test-V2024ExternalExecuteWorkflow -V2024Id $Id + Test-V2024ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Test-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest + # Test-V2024ExternalExecuteWorkflow -Id $Id -V2024TestExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-workflow Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** +[API Spec](https://developer.sailpoint.com/docs/api/v2024/test-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -870,10 +924,10 @@ $TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b, try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2024Workflow -V2024Id $Id -V2024TestWorkflowRequest $Result + Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Test-V2024Workflow -V2024Id $Id -V2024TestWorkflowRequest $TestWorkflowRequest + # Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/index.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/index.md index 7b5a06e9a..12871a139 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/index.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/index.md @@ -11,7 +11,6 @@ tags: ['SDK', 'Software Development Kit', 'v2024', 'methods'] --- Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. - ## Key Features - Purpose & Overview: Explains the purpose of the method and its role in the API. - Parameters: Describe the required input parameters, including their data types. diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md index b901e027d..9cb9ee94f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AggregationResult.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AggregationResult.md index 5a9ef0081..b79b6ba26 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AggregationResult.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AggregationResult.md @@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'V2024Aggregation Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Aggregations** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional] -**Hits** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The results of the aggregation search query. | [optional] +**Hits** | [**[]SearchDocument**](search-document) | The results of the aggregation search query. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md index 98864c447..32dcea19c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **Description** | **String** | The description of the saved search. | [optional] **Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional] **Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional] -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required] **Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] **Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] **Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index e6ea69959..f186fdf6b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/PendingApproval.md b/docs/tools/sdk/powershell/Reference/V2024/Models/PendingApproval.md index 8142b69ae..14843a4b3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/PendingApproval.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/PendingApproval.md @@ -17,6 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'V2024PendingApprov Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **String** | The approval id. | [optional] +**AccessRequestId** | **String** | This is the access request id. | [optional] **Name** | **String** | The name of the approval. | [optional] **Created** | **System.DateTime** | When the approval was created. | [optional] **Modified** | **System.DateTime** | When the approval was modified last time. | [optional] @@ -41,6 +42,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $PendingApproval = Initialize-PSSailpoint.V2024PendingApproval -Id id12345 ` + -AccessRequestId 2b838de9db9babcfe646d4f274ad4238 ` -Name aName ` -Created 2017-07-11T18:45:37.098Z ` -Modified 2018-07-25T20:22:28.104Z ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ReportDetailsArguments.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ReportDetailsArguments.md index fa4ef45bc..317e8e20b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ReportDetailsArguments.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ReportDetailsArguments.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false] **AuthoritativeSource** | **String** | Source ID. | [required] **SelectedFormats** | **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] **Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] **Columns** | **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] **Sort** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md index ea2ff0b35..747bb3ecf 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **Description** | **String** | The description of the saved search. | [optional] **Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional] **Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional] -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required] **Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] **Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] **Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md index 9905e0516..dbf171b39 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional] **Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional] -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required] **Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] **Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] **Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md index 17504dd24..db75fbea9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Search', 'V2024Search'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] **QueryType** | [**QueryType**](query-type) | | [optional] **QueryVersion** | **String** | | [optional] **Query** | [**Query**](query) | | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchDocument.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchDocument.md new file mode 100644 index 000000000..10fcde8ab --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchDocument.md @@ -0,0 +1,169 @@ +--- +id: v2024-search-document +title: SearchDocument +pagination_label: SearchDocument +sidebar_label: SearchDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchDocument', 'V2024SearchDocument'] +slug: /tools/sdk/powershell/v2024/models/search-document +tags: ['SDK', 'Software Development Kit', 'SearchDocument', 'V2024SearchDocument'] +--- + + +# SearchDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the referenced object. | [required] +**Name** | **String** | The human readable name of the referenced object. | [required] +**Description** | **String** | Access item's description. | [optional] +**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Enabled** | **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false] +**Requestable** | **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true] +**RequestCommentsRequired** | **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false] +**Owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional] +**Type** | [**DocumentType**](document-type) | | [required] +**Source** | [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] +**Entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional] +**EntitlementCount** | **Int32** | Number of entitlements included with the role. | [optional] +**Tags** | **[]String** | Tags that have been applied to the object. | [optional] +**Action** | **String** | Name of the event as it's displayed in audit reports. | [optional] +**Stage** | **String** | Activity's current stage. | [optional] +**Origin** | **String** | Activity's origin. | [optional] +**Status** | **String** | Identity's status in SailPoint. | [optional] +**Requester** | [**AccountSource**](account-source) | | [optional] +**Recipient** | [**AccountSource**](account-source) | | [optional] +**TrackingNumber** | **String** | ID of the group of events. | [optional] +**Errors** | **[]String** | Errors provided by the source while completing account actions. | [optional] +**Warnings** | **[]String** | Warnings provided by the source while completing account actions. | [optional] +**Approvals** | [**[]Approval1**](approval1) | Approvals performed on an item during activity. | [optional] +**OriginalRequests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**ExpansionItems** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**AccountRequests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**Sources** | **String** | Sources involved in the account activity. | [optional] +**DisplayName** | **String** | Identity's display name. | [optional] +**Segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**SegmentCount** | **Int32** | Number of segments with the role. | [optional] +**CloudGoverned** | **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false] +**Privileged** | **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false] +**IdentityCount** | **Int32** | Number of identities who have access to the entitlement. | [optional] +**Type** | **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | **String** | Name of the actor that generated the event. | [optional] +**Target** | **String** | Name of the target, or recipient, of the event. | [optional] +**Stack** | **String** | The event's stack. | [optional] +**IpAddress** | **String** | Target system's IP address. | [optional] +**Details** | **String** | ID of event's details. | [optional] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional] +**Objects** | **[]String** | Objects the event is happening to. | [optional] +**Operation** | **String** | Operation, or action, performed during the event. | [optional] +**TechnicalName** | **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] +**FirstName** | **String** | Identity's first name. | [optional] +**LastName** | **String** | Identity's last name. | [optional] +**Email** | **String** | Identity's primary email address. | [optional] +**Phone** | **String** | Identity's phone number. | [optional] +**Inactive** | **Boolean** | Indicates whether the identity is inactive. | [optional] [default to $false] +**Protected** | **Boolean** | Indicates whether the identity is protected. | [optional] [default to $false] +**EmployeeNumber** | **String** | Identity's employee number. | [optional] +**Manager** | [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] +**IsManager** | **Boolean** | Indicates whether the identity is a manager of other identities. | [optional] +**IdentityProfile** | [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] +**ProcessingState** | **String** | Identity's processing state. | [optional] +**ProcessingDetails** | [**ProcessingDetails**](processing-details) | | [optional] +**Accounts** | [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] +**AccountCount** | **Int32** | Number of accounts associated with the identity. | [optional] +**Apps** | [**[]App**](app) | List of applications the identity has access to. | [optional] +**AppCount** | **Int32** | Number of applications the identity has access to. | [optional] +**Access** | [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] +**AccessCount** | **Int32** | Number of access items assigned to the identity. | [optional] +**RoleCount** | **Int32** | Number of roles assigned to the identity. | [optional] +**AccessProfileCount** | **Int32** | Number of access profiles included with the role. | [optional] +**Owns** | [**[]Owns**](owns) | Access items the identity owns. | [optional] +**OwnsCount** | **Int32** | Number of access items the identity owns. | [optional] +**AccessProfiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchDocument = Initialize-PSSailpoint.V2024SearchDocument -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Description The admin role ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced 2018-06-25T20:22:33.104Z ` + -Enabled true ` + -Requestable true ` + -RequestCommentsRequired false ` + -Owner null ` + -Type null ` + -Source null ` + -Entitlements null ` + -EntitlementCount 3 ` + -Tags [TAG_1, TAG_2] ` + -Action update ` + -Stage Completed ` + -Origin null ` + -Status UNREGISTERED ` + -Requester null ` + -Recipient null ` + -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` + -Errors null ` + -Warnings null ` + -Approvals null ` + -OriginalRequests null ` + -ExpansionItems null ` + -AccountRequests null ` + -Sources smartsheet-test, airtable-v4, IdentityNow ` + -DisplayName Carol.Adams ` + -Segments null ` + -SegmentCount 1 ` + -CloudGoverned false ` + -Privileged false ` + -IdentityCount 3 ` + -Type SYSTEM_CONFIG ` + -Actor System ` + -Target Carol.Adams ` + -Stack tpe ` + -IpAddress 52.52.97.85 ` + -Details 73b65dfbed1842548c207432a18c84b0 ` + -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` + -Objects null ` + -Operation REQUEST ` + -TechnicalName AUTHENTICATION_REQUEST_PASSED ` + -FirstName Carol ` + -LastName Adams ` + -Email Carol.Adams@sailpointdemo.com ` + -Phone +1 440-527-3672 ` + -Inactive false ` + -Protected false ` + -EmployeeNumber 1a2a3d4e ` + -Manager null ` + -IsManager false ` + -IdentityProfile null ` + -ProcessingState null ` + -ProcessingDetails null ` + -Accounts null ` + -AccountCount 3 ` + -Apps null ` + -AppCount 2 ` + -Access null ` + -AccessCount 5 ` + -RoleCount 1 ` + -AccessProfileCount 1 ` + -Owns null ` + -OwnsCount 5 ` + -AccessProfiles null +``` + +- Convert the resource to JSON +```powershell +$SearchDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchExportReportArguments.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchExportReportArguments.md index 8ac338a57..24d6eec96 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchExportReportArguments.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchExportReportArguments.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'V2024S Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] **Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] **Columns** | **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] **Sort** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md index 3d6b4c94a..235e4ab2c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/index.md b/docs/tools/sdk/powershell/Reference/V2024/Models/index.md index 8c3571456..984910d01 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/index.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/index.md @@ -10,10 +10,9 @@ slug: /tools/sdk/powershell/v2024/models tags: ['SDK', 'Software Development Kit', 'v2024', 'models'] --- -The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. - +The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. ## Key Features - Attributes: Describe each attribute, including its name, data type, and whether it's required. - Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. -- Example: Provides a sample of how the API uses the model. +- Example: Provides a sample of how the API uses the model. \ No newline at end of file diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md index a6530a82b..057996d67 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md @@ -59,11 +59,14 @@ Method | HTTP request | Description [**Get-AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles [**Update-AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile + ## create-access-profile Use this API to create an access profile. A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -178,16 +181,17 @@ $AccessProfile = @"{ try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-AccessProfile -AccessProfile $Result + New-AccessProfile -AccessProfile $Result # Below is a request that includes all optional parameters - # New-AccessProfile -AccessProfile $AccessProfile + # New-AccessProfile -AccessProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-access-profile This API deletes an existing Access Profile. @@ -195,6 +199,8 @@ The Access Profile must not be in use, for example, Access Profile can not be de A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -234,6 +240,7 @@ try { } ``` [[Back to top]](#) + ## delete-access-profiles-in-bulk This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. @@ -241,6 +248,8 @@ This endpoint can only bulk delete up to a limit of 50 access profiles per reque By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-access-profiles-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -275,19 +284,22 @@ $AccessProfileBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result + Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest + # Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfilesInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-profile This API returns an Access Profile by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -327,11 +339,14 @@ try { } ``` [[Back to top]](#) + ## get-access-profile-entitlements Use this API to get a list of an access profile's entitlements. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-profile-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -381,10 +396,13 @@ try { } ``` [[Back to top]](#) + ## list-access-profiles Use this API to get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -428,7 +446,7 @@ $IncludeUnsegmented = $false # Boolean | Indicates whether the response list sho # List Access Profiles try { - Get-AccessProfiles + Get-AccessProfiles # Below is a request that includes all optional parameters # Get-AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented @@ -438,6 +456,7 @@ try { } ``` [[Back to top]](#) + ## patch-access-profile This API updates an existing Access Profile. The following fields are patchable: @@ -470,6 +489,8 @@ A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-access-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -507,10 +528,10 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AccessProfile -Id $Id -JsonPatchOperation $Result + Update-AccessProfile -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-AccessProfile -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-AccessProfile -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessProfile" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md index 5e07a8429..1c37e9979 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md @@ -41,9 +41,12 @@ Method | HTTP request | Description [**Get-PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List [**Deny-AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + ## approve-access-request Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -87,16 +90,19 @@ try { Approve-AccessRequest -ApprovalId $ApprovalId # Below is a request that includes all optional parameters - # Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto + # Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-AccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## forward-access-request Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. +[API Spec](https://developer.sailpoint.com/docs/api/v3/forward-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -133,19 +139,22 @@ $ForwardApprovalDto = @"{ try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result + Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result # Below is a request that includes all optional parameters - # Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $ForwardApprovalDto + # Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ForwardAccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-approval-summary Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-request-approval-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -177,7 +186,7 @@ $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and tim # Get Access Requests Approvals Number try { - Get-AccessRequestApprovalSummary + Get-AccessRequestApprovalSummary # Below is a request that includes all optional parameters # Get-AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate @@ -187,9 +196,12 @@ try { } ``` [[Back to top]](#) + ## list-completed-approvals This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-completed-approvals) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -229,7 +241,7 @@ $Sorters = "modified" # String | Sort results using the standard syntax describe # Completed Access Request Approvals List try { - Get-CompletedApprovals + Get-CompletedApprovals # Below is a request that includes all optional parameters # Get-CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters @@ -239,9 +251,12 @@ try { } ``` [[Back to top]](#) + ## list-pending-approvals This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-pending-approvals) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -249,7 +264,7 @@ 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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. - 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* + 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* Query | Sorters | **String** | (optional) | 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: **created, modified** ### Return type @@ -275,13 +290,13 @@ $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value r $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) $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) -$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) $Sorters = "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: **created, modified** (optional) # Pending Access Request Approvals List try { - Get-PendingApprovals + Get-PendingApprovals # Below is a request that includes all optional parameters # Get-PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters @@ -291,9 +306,12 @@ try { } ``` [[Back to top]](#) + ## reject-access-request Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -335,10 +353,10 @@ $CommentDto = @"{ try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result + Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result # Below is a request that includes all optional parameters - # Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto + # Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-AccessRequest" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md index fd6199fd6..938669ce4 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md @@ -38,10 +38,13 @@ Method | HTTP request | Description [**Get-AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status [**Set-AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration + ## cancel-access-request This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. +[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -76,16 +79,17 @@ $CancelAccessRequest = @"{ try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-AccessRequest -CancelAccessRequest $Result + Suspend-AccessRequest -CancelAccessRequest $Result # Below is a request that includes all optional parameters - # Suspend-AccessRequest -CancelAccessRequest $CancelAccessRequest + # Suspend-AccessRequest -CancelAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-AccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-access-request Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. @@ -119,6 +123,8 @@ __REVOKE_ACCESS__ * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -202,19 +208,22 @@ $AccessRequest = @"{ try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-AccessRequest -AccessRequest $Result + New-AccessRequest -AccessRequest $Result # Below is a request that includes all optional parameters - # New-AccessRequest -AccessRequest $AccessRequest + # New-AccessRequest -AccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-access-request-config This endpoint returns the current access-request configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-access-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -242,7 +251,7 @@ Code | Description | Data Type # Get Access Request Configuration try { - Get-AccessRequestConfig + Get-AccessRequestConfig # Below is a request that includes all optional parameters # Get-AccessRequestConfig @@ -252,11 +261,14 @@ try { } ``` [[Back to top]](#) + ## list-access-request-status Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-request-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -304,7 +316,7 @@ $RequestState = "request-state=EXECUTING" # String | Filter the results by the s # Access Request Status try { - Get-AccessRequestStatus + Get-AccessRequestStatus # Below is a request that includes all optional parameters # Get-AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState @@ -314,9 +326,12 @@ try { } ``` [[Back to top]](#) + ## set-access-request-config This endpoint replaces the current access-request configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-access-request-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -372,10 +387,10 @@ $AccessRequestConfig = @"{ try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-AccessRequestConfig -AccessRequestConfig $Result + Set-AccessRequestConfig -AccessRequestConfig $Result # Below is a request that includes all optional parameters - # Set-AccessRequestConfig -AccessRequestConfig $AccessRequestConfig + # Set-AccessRequestConfig -AccessRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-AccessRequestConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountActivitiesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountActivitiesApi.md index a592dd3ac..4089faf3d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountActivitiesApi.md @@ -53,9 +53,12 @@ Method | HTTP request | Description [**Get-AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity [**Get-AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities + ## get-account-activity This gets a single account activity by its id. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-activity) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -96,9 +99,12 @@ try { } ``` [[Back to top]](#) + ## list-account-activities This gets a collection of account activities that satisfy the given query parameters. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-account-activities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -142,7 +148,7 @@ $Sorters = "created" # String | Sort results using the standard syntax described # List Account Activities try { - Get-AccountActivities + Get-AccountActivities # Below is a request that includes all optional parameters # Get-AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountUsagesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountUsagesApi.md index 9fff57fb6..321e90720 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountUsagesApi.md @@ -22,9 +22,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-UsagesByAccountId**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights + ## get-usages-by-account-id This API returns a summary of account usage insights for past 12 months. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-usages-by-account-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md index f2a5c6214..410d3e052 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md @@ -56,6 +56,7 @@ Method | HTTP request | Description [**Unlock-Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account [**Update-Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account + ## create-account Submit an account creation task - the API then returns the task ID. @@ -70,6 +71,8 @@ The endpoint doesn't actually provision the account on the target source, which By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -109,22 +112,25 @@ $AccountAttributesCreate = @"{ try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-Account -AccountAttributesCreate $Result + New-Account -AccountAttributesCreate $Result # Below is a request that includes all optional parameters - # New-Account -AccountAttributesCreate $AccountAttributesCreate + # New-Account -AccountAttributesCreate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-account Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. >**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -165,9 +171,12 @@ try { } ``` [[Back to top]](#) + ## disable-account This API submits a task to disable the account and returns the task ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/disable-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -204,19 +213,22 @@ $AccountToggleRequest = @"{ try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-Account -Id $Id -AccountToggleRequest $Result + Disable-Account -Id $Id -AccountToggleRequest $Result # Below is a request that includes all optional parameters - # Disable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest + # Disable-Account -Id $Id -AccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## enable-account This API submits a task to enable account and returns the task ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/enable-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -253,19 +265,22 @@ $AccountToggleRequest = @"{ try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-Account -Id $Id -AccountToggleRequest $Result + Enable-Account -Id $Id -AccountToggleRequest $Result # Below is a request that includes all optional parameters - # Enable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest + # Enable-Account -Id $Id -AccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-account Use this API to return the details for a single account by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -306,9 +321,12 @@ try { } ``` [[Back to top]](#) + ## get-account-entitlements This API returns entitlements of the account. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-account-entitlements) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -355,9 +373,12 @@ try { } ``` [[Back to top]](#) + ## list-accounts List accounts. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-accounts) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -397,7 +418,7 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described # Accounts List try { - Get-Accounts + Get-Accounts # Below is a request that includes all optional parameters # Get-Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters @@ -407,6 +428,7 @@ try { } ``` [[Back to top]](#) + ## put-account Use this API to update an account with a PUT request. @@ -415,6 +437,8 @@ This endpoint submits an account update task and returns the task ID. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.** +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -456,19 +480,22 @@ $AccountAttributes = @"{ try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-Account -Id $Id -AccountAttributes $Result + Send-Account -Id $Id -AccountAttributes $Result # Below is a request that includes all optional parameters - # Send-Account -Id $Id -AccountAttributes $AccountAttributes + # Send-Account -Id $Id -AccountAttributes $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-reload-account This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. +[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-reload-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -509,10 +536,13 @@ try { } ``` [[Back to top]](#) + ## unlock-account This API submits a task to unlock an account and returns the task ID. To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. +[API Spec](https://developer.sailpoint.com/docs/api/v3/unlock-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -550,16 +580,17 @@ $AccountUnlockRequest = @"{ try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-Account -Id $Id -AccountUnlockRequest $Result + Unlock-Account -Id $Id -AccountUnlockRequest $Result # Below is a request that includes all optional parameters - # Unlock-Account -Id $Id -AccountUnlockRequest $AccountUnlockRequest + # Unlock-Account -Id $Id -AccountUnlockRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-Account" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-account Use this API to update account details. @@ -573,6 +604,8 @@ All accounts that are reassigned will be set to `manuallyCorrelated: true` unles >**Note:** The `attributes` field can only be modified for flat file accounts. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-account) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -608,10 +641,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-Account -Id $Id -RequestBody $Result + Update-Account -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Update-Account -Id $Id -RequestBody $RequestBody + # Update-Account -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ApplicationDiscoveryApi.md index c37e99e60..1f252b187 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ApplicationDiscoveryApi.md @@ -23,10 +23,13 @@ Method | HTTP request | Description [**Get-ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery [**Send-ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications + ## 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](https://developer.sailpoint.com/docs/api/v3/get-discovered-applications) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -64,7 +67,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # Get Discovered Applications for Tenant try { - Get-DiscoveredApplications + Get-DiscoveredApplications # Below is a request that includes all optional parameters # Get-DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters @@ -74,12 +77,15 @@ try { } ``` [[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](https://developer.sailpoint.com/docs/api/v3/get-manual-discover-applications-csv-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -107,7 +113,7 @@ Code | Description | Data Type # Download CSV Template for Discovery try { - Get-ManualDiscoverApplicationsCsvTemplate + Get-ManualDiscoverApplicationsCsvTemplate # Below is a request that includes all optional parameters # Get-ManualDiscoverApplicationsCsvTemplate @@ -117,10 +123,13 @@ try { } ``` [[Back to top]](#) + ## send-manual-discover-applications-csv-template Uploading 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](https://developer.sailpoint.com/docs/api/v3/send-manual-discover-applications-csv-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AuthUsersApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AuthUsersApi.md index 00f5e7b6c..d9eeedc3f 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AuthUsersApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AuthUsersApi.md @@ -25,9 +25,12 @@ Method | HTTP request | Description [**Get-AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details [**Update-AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update + ## get-auth-user Return the specified user's authentication system details. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-user) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -68,6 +71,7 @@ try { } ``` [[Back to top]](#) + ## patch-auth-user Use a PATCH request to update an existing user in the authentication system. Use this endpoint to modify these fields: @@ -75,6 +79,8 @@ Use this endpoint to modify these fields: A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-user) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -113,10 +119,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AuthUser -Id $Id -JsonPatchOperation $Result + Update-AuthUser -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-AuthUser -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-AuthUser -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthUser" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/BrandingApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/BrandingApi.md index eefe2dc10..0ab14a633 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/BrandingApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/BrandingApi.md @@ -28,9 +28,12 @@ Method | HTTP request | Description [**Get-BrandingList**](#get-branding-list) | **GET** `/brandings` | List of branding items [**Set-BrandingItem**](#set-branding-item) | **PUT** `/brandings/{name}` | Update a branding item + ## create-branding-item This API endpoint creates a branding item. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-branding-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -74,7 +77,7 @@ $FileStandard = # System.IO.FileInfo | png file with logo (optional) # Create a branding item try { - New-BrandingItem -Name $Name -ProductName $ProductName + New-BrandingItem -Name $Name -ProductName $ProductName # Below is a request that includes all optional parameters # New-BrandingItem -Name $Name -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard @@ -84,9 +87,12 @@ try { } ``` [[Back to top]](#) + ## delete-branding This API endpoint delete information for an existing branding item by name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-branding) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -127,9 +133,12 @@ try { } ``` [[Back to top]](#) + ## get-branding This API endpoint retrieves information for an existing branding item by name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-branding) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -170,9 +179,12 @@ try { } ``` [[Back to top]](#) + ## get-branding-list This API endpoint returns a list of branding items. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-branding-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -200,7 +212,7 @@ Code | Description | Data Type # List of branding items try { - Get-BrandingList + Get-BrandingList # Below is a request that includes all optional parameters # Get-BrandingList @@ -210,9 +222,12 @@ try { } ``` [[Back to top]](#) + ## set-branding-item This API endpoint updates information for an existing branding item. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-branding-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -259,7 +274,7 @@ $FileStandard = # System.IO.FileInfo | png file with logo (optional) # Update a branding item try { - Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName + Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName # Below is a request that includes all optional parameters # Set-BrandingItem -Name $Name -Name2 $Name2 -ProductName $ProductName -ActionButtonColor $ActionButtonColor -ActiveLinkColor $ActiveLinkColor -NavigationColor $NavigationColor -EmailFromAddress $EmailFromAddress -LoginInformationalMessage $LoginInformationalMessage -FileStandard $FileStandard diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignFiltersApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignFiltersApi.md index fdb7a67c7..7e40ca3f6 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignFiltersApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignFiltersApi.md @@ -50,9 +50,12 @@ Method | HTTP request | Description [**Get-CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters [**Update-CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter + ## create-campaign-filter Use this API to create a campaign filter based on filter details and criteria. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign-filter) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -100,19 +103,22 @@ $CampaignFilterDetails = @"{ try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - New-CampaignFilter -CampaignFilterDetails $Result + New-CampaignFilter -CampaignFilterDetails $Result # Below is a request that includes all optional parameters - # New-CampaignFilter -CampaignFilterDetails $CampaignFilterDetails + # New-CampaignFilter -CampaignFilterDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignFilter" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-campaign-filters Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-filters) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -146,19 +152,22 @@ $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filte try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-CampaignFilters -RequestBody $Result + Remove-CampaignFilters -RequestBody $Result # Below is a request that includes all optional parameters - # Remove-CampaignFilters -RequestBody $RequestBody + # Remove-CampaignFilters -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignFilters" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-campaign-filter-by-id Retrieves information for an existing campaign filter using the filter's ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-filter-by-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -199,9 +208,12 @@ try { } ``` [[Back to top]](#) + ## list-campaign-filters Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-campaign-filters) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -235,7 +247,7 @@ $IncludeSystemFilters = $true # Boolean | If this is true, the API includes syst # List Campaign Filters try { - Get-CampaignFilters + Get-CampaignFilters # Below is a request that includes all optional parameters # Get-CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters @@ -245,9 +257,12 @@ try { } ``` [[Back to top]](#) + ## update-campaign-filter Updates an existing campaign filter using the filter's ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-campaign-filter) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -297,10 +312,10 @@ $CampaignFilterDetails = @"{ try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result + Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result # Below is a request that includes all optional parameters - # Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $CampaignFilterDetails + # Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignFilter" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md index a3fa8af23..75be21ef7 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md @@ -105,6 +105,7 @@ Method | HTTP request | Description [**Start-GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template [**Update-Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign + ## complete-campaign :::caution @@ -118,6 +119,8 @@ Use this API to complete a certification campaign. This functionality is provide can complete a certification even if all items have not been completed. +[API Spec](https://developer.sailpoint.com/docs/api/v3/complete-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -155,17 +158,20 @@ try { Complete-Campaign -Id $Id # Below is a request that includes all optional parameters - # Complete-Campaign -Id $Id -CampaignCompleteOptions $CampaignCompleteOptions + # Complete-Campaign -Id $Id -CampaignCompleteOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-Campaign" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-campaign Use this API to create a certification campaign with the information provided in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -304,20 +310,23 @@ $Campaign = @"{ try { $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-Campaign -Campaign $Result + New-Campaign -Campaign $Result # Below is a request that includes all optional parameters - # New-Campaign -Campaign $Campaign + # New-Campaign -Campaign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Campaign" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-campaign-template Use this API to create a certification campaign template based on campaign. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -471,20 +480,23 @@ $CampaignTemplate = @"{ try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-CampaignTemplate -CampaignTemplate $Result + New-CampaignTemplate -CampaignTemplate $Result # Below is a request that includes all optional parameters - # New-CampaignTemplate -CampaignTemplate $CampaignTemplate + # New-CampaignTemplate -CampaignTemplate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-campaign-template Use this API to delete a certification campaign template by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -525,10 +537,13 @@ try { } ``` [[Back to top]](#) + ## delete-campaign-template-schedule Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -569,10 +584,13 @@ try { } ``` [[Back to top]](#) + ## delete-campaigns Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-campaigns) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -606,20 +624,23 @@ $CampaignsDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest - Remove-Campaigns -CampaignsDeleteRequest $Result + Remove-Campaigns -CampaignsDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-Campaigns -CampaignsDeleteRequest $CampaignsDeleteRequest + # Remove-Campaigns -CampaignsDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Campaigns" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-active-campaigns Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -659,7 +680,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # List Campaigns try { - Get-ActiveCampaigns + Get-ActiveCampaigns # Below is a request that includes all optional parameters # Get-ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters @@ -669,10 +690,13 @@ try { } ``` [[Back to top]](#) + ## get-campaign Use this API to get information for an existing certification campaign by the campaign's ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -715,10 +739,13 @@ try { } ``` [[Back to top]](#) + ## get-campaign-reports Use this API to fetch all reports for a certification campaign by campaign ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -759,10 +786,13 @@ try { } ``` [[Back to top]](#) + ## get-campaign-reports-config Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -790,7 +820,7 @@ Code | Description | Data Type # Get Campaign Reports Configuration try { - Get-CampaignReportsConfig + Get-CampaignReportsConfig # Below is a request that includes all optional parameters # Get-CampaignReportsConfig @@ -800,10 +830,13 @@ try { } ``` [[Back to top]](#) + ## get-campaign-template Use this API to fetch a certification campaign template by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -844,10 +877,13 @@ try { } ``` [[Back to top]](#) + ## get-campaign-template-schedule Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -888,12 +924,15 @@ try { } ``` [[Back to top]](#) + ## get-campaign-templates Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-campaign-templates) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -931,7 +970,7 @@ $Filters = 'name eq "manager template"' # String | Filter results using the stan # List Campaign Templates try { - Get-CampaignTemplates + Get-CampaignTemplates # Below is a request that includes all optional parameters # Get-CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters @@ -941,10 +980,13 @@ try { } ``` [[Back to top]](#) + ## move This API reassigns the specified certifications from one identity to another. +[API Spec](https://developer.sailpoint.com/docs/api/v3/move) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -985,20 +1027,23 @@ $AdminReviewReassign = @"{ try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move- -Id $Id -AdminReviewReassign $Result + Move- -Id $Id -AdminReviewReassign $Result # Below is a request that includes all optional parameters - # Move- -Id $Id -AdminReviewReassign $AdminReviewReassign + # Move- -Id $Id -AdminReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-campaign-template Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1037,20 +1082,23 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result + Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-CampaignTemplate -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-CampaignTemplate -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignTemplate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-campaign-reports-config Use this API to overwrite the configuration for campaign reports. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1083,20 +1131,23 @@ $CampaignReportsConfig = @"{ try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-CampaignReportsConfig -CampaignReportsConfig $Result + Set-CampaignReportsConfig -CampaignReportsConfig $Result # Below is a request that includes all optional parameters - # Set-CampaignReportsConfig -CampaignReportsConfig $CampaignReportsConfig + # Set-CampaignReportsConfig -CampaignReportsConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignReportsConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-campaign-template-schedule Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1151,17 +1202,20 @@ try { Set-CampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters - # Set-CampaignTemplateSchedule -Id $Id -Schedule $Schedule + # Set-CampaignTemplateSchedule -Id $Id -Schedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignTemplateSchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-campaign Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1199,17 +1253,20 @@ try { Start-Campaign -Id $Id # Below is a request that includes all optional parameters - # Start-Campaign -Id $Id -ActivateCampaignOptions $ActivateCampaignOptions + # Start-Campaign -Id $Id -ActivateCampaignOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Campaign" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-campaign-remediation-scan Use this API to run a remediation scan task for a certification campaign. +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1250,10 +1307,13 @@ try { } ``` [[Back to top]](#) + ## start-campaign-report Use this API to run a report for a certification campaign. +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-campaign-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1286,7 +1346,7 @@ $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. # Run Campaign Report try { - Start-CampaignReport -Id $Id -Type $Type + Start-CampaignReport -Id $Id -Type $Type # Below is a request that includes all optional parameters # Start-CampaignReport -Id $Id -Type $Type @@ -1296,6 +1356,7 @@ try { } ``` [[Back to top]](#) + ## start-generate-campaign-template Use this API to generate a new certification campaign from a campaign template. @@ -1310,6 +1371,8 @@ campaign called "Campaign for 2020" (assuming the year at generation time is 202 Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1349,10 +1412,13 @@ try { } ``` [[Back to top]](#) + ## update-campaign Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-campaign) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1391,10 +1457,10 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Campaign -Id $Id -JsonPatchOperation $Result + Update-Campaign -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-Campaign -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-Campaign -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationSummariesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationSummariesApi.md index 4fc35c500..11c899a6d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationSummariesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationSummariesApi.md @@ -36,9 +36,12 @@ Method | HTTP request | Description [**Get-IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification [**Get-IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity + ## get-identity-access-summaries This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-access-summaries) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -81,7 +84,7 @@ $Sorters = "access.name" # String | Sort results using the standard syntax descr # Access Summaries try { - Get-IdentityAccessSummaries -Id $Id -Type $Type + Get-IdentityAccessSummaries -Id $Id -Type $Type # Below is a request that includes all optional parameters # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters @@ -91,9 +94,12 @@ try { } ``` [[Back to top]](#) + ## get-identity-decision-summary This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-decision-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -136,9 +142,12 @@ try { } ``` [[Back to top]](#) + ## get-identity-summaries This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summaries) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -189,9 +198,12 @@ try { } ``` [[Back to top]](#) + ## get-identity-summary This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -224,7 +236,7 @@ $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity # Summary for Identity try { - Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId # Below is a request that includes all optional parameters # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationsApi.md index ba2026cd2..fb85dbb01 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationsApi.md @@ -52,9 +52,12 @@ Method | HTTP request | Description [**Invoke-SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions [**Submit-ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + ## get-certification-task This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-certification-task) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -95,9 +98,12 @@ try { } ``` [[Back to top]](#) + ## get-identity-certification This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -138,9 +144,12 @@ try { } ``` [[Back to top]](#) + ## get-identity-certification-item-permissions This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-certification-item-permissions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -181,7 +190,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Permissions for Entitlement Certification Item try { - Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId + Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId # Below is a request that includes all optional parameters # Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count @@ -191,9 +200,12 @@ try { } ``` [[Back to top]](#) + ## get-pending-certification-tasks This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-pending-certification-tasks) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -232,7 +244,7 @@ $Filters = 'type eq "ADMIN_REASSIGN"' # String | Filter results using the standa # List of Pending Certification Tasks try { - Get-PendingCertificationTasks + Get-PendingCertificationTasks # Below is a request that includes all optional parameters # Get-PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters @@ -242,9 +254,12 @@ try { } ``` [[Back to top]](#) + ## list-certification-reviewers This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-certification-reviewers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -295,9 +310,12 @@ try { } ``` [[Back to top]](#) + ## list-identity-access-review-items This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-access-review-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -354,9 +372,12 @@ try { } ``` [[Back to top]](#) + ## list-identity-certifications Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-certifications) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -396,7 +417,7 @@ $Sorters = "name,due" # String | Sort results using the standard syntax describe # List Identity Campaign Certifications try { - Get-IdentityCertifications + Get-IdentityCertifications # Below is a request that includes all optional parameters # Get-IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters @@ -406,9 +427,12 @@ try { } ``` [[Back to top]](#) + ## make-identity-decision The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. +[API Spec](https://developer.sailpoint.com/docs/api/v3/make-identity-decision) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -454,19 +478,22 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campa try { $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision - Select-IdentityDecision -Id $Id -ReviewDecision $Result + Select-IdentityDecision -Id $Id -ReviewDecision $Result # Below is a request that includes all optional parameters - # Select-IdentityDecision -Id $Id -ReviewDecision $ReviewDecision + # Select-IdentityDecision -Id $Id -ReviewDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-IdentityDecision" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reassign-identity-certifications This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. +[API Spec](https://developer.sailpoint.com/docs/api/v3/reassign-identity-certifications) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -510,19 +537,22 @@ $ReviewReassign = @"{ try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result + Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result # Below is a request that includes all optional parameters - # Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $ReviewReassign + # Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ReassignIdentityCertifications" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## sign-off-identity-certification This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. +[API Spec](https://developer.sailpoint.com/docs/api/v3/sign-off-identity-certification) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -563,6 +593,7 @@ try { } ``` [[Back to top]](#) + ## submit-reassign-certs-async This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the @@ -571,6 +602,8 @@ reassignment is complete. Reviewers for this certification can also call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-reassign-certs-async) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -614,10 +647,10 @@ $ReviewReassign = @"{ try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result + Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result # Below is a request that includes all optional parameters - # Submit-ReassignCertsAsync -Id $Id -ReviewReassign $ReviewReassign + # Submit-ReassignCertsAsync -Id $Id -ReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ConfigurationHubApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ConfigurationHubApi.md index fdaeac3ad..8279878e1 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ConfigurationHubApi.md @@ -36,12 +36,15 @@ Method | HTTP request | Description [**Get-UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations [**Update-ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings + ## create-object-mapping This creates an object mapping between current org and source org. Source org should be "default" when creating an object mapping that is not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-object-mapping) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -81,22 +84,25 @@ $ObjectMappingRequest = @"{ try { $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest - New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result + New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result # Below is a request that includes all optional parameters - # New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $ObjectMappingRequest + # New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMapping" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-object-mappings This creates a set of object mappings (Max 25) between current org and source org. Source org should be "default" when creating object mappings that are not to be associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-object-mappings) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -144,16 +150,17 @@ $ObjectMappingBulkCreateRequest = @"{ try { $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest - New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result # Below is a request that includes all optional parameters - # New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest + # New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMappings" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-uploaded-configuration This API uploads a JSON configuration file into a tenant. @@ -161,6 +168,8 @@ Configuration files can be managed and deployed via Configuration Hub by uploadi Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-uploaded-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -192,7 +201,7 @@ $Name = "MyName" # String | Name that will be assigned to the uploaded configura # Upload a Configuration try { - New-UploadedConfiguration -Data $Data -Name $Name + New-UploadedConfiguration -Data $Data -Name $Name # Below is a request that includes all optional parameters # New-UploadedConfiguration -Data $Data -Name $Name @@ -202,12 +211,15 @@ try { } ``` [[Back to top]](#) + ## delete-object-mapping This deletes an existing object mapping. Source org should be "default" when deleting an object mapping that is not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-object-mapping) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -240,7 +252,7 @@ $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of t # Deletes an object mapping try { - Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId # Below is a request that includes all optional parameters # Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId @@ -250,6 +262,7 @@ try { } ``` [[Back to top]](#) + ## delete-uploaded-configuration This API deletes an uploaded configuration based on Id. @@ -257,6 +270,8 @@ On success, this endpoint will return an empty response. The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-uploaded-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -297,12 +312,15 @@ try { } ``` [[Back to top]](#) + ## get-object-mappings This gets a list of existing object mappings between current org and source org. Source org should be "default" when getting object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:read +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-object-mappings) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -343,9 +361,12 @@ try { } ``` [[Back to top]](#) + ## get-uploaded-configuration This API gets an existing uploaded configuration for the current tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-uploaded-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -386,9 +407,12 @@ try { } ``` [[Back to top]](#) + ## list-uploaded-configurations This API gets a list of existing uploaded configurations for the current tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-uploaded-configurations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -419,7 +443,7 @@ $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard s # List Uploaded Configurations try { - Get-UploadedConfigurations + Get-UploadedConfigurations # Below is a request that includes all optional parameters # Get-UploadedConfigurations -Filters $Filters @@ -429,12 +453,15 @@ try { } ``` [[Back to top]](#) + ## update-object-mappings This updates a set of object mappings, only enabled and targetValue fields can be updated. Source org should be "default" when updating object mappings that are not associated to any particular org. The request will need the following security scope: - sp:config-object-mapping:manage +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-object-mappings) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -481,10 +508,10 @@ $ObjectMappingBulkPatchRequest = @"{ try { $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest - Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result # Below is a request that includes all optional parameters - # Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest + # Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ObjectMappings" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ConnectorsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ConnectorsApi.md index 1ccb2bcae..0cf53a89c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ConnectorsApi.md @@ -43,9 +43,12 @@ Method | HTTP request | Description [**Send-ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations [**Update-Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name + ## create-custom-connector Create custom connector. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-custom-connector) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -83,19 +86,22 @@ $V3CreateConnectorDto = @"{ try { $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto - New-CustomConnector -V3CreateConnectorDto $Result + New-CustomConnector -V3CreateConnectorDto $Result # Below is a request that includes all optional parameters - # New-CustomConnector -V3CreateConnectorDto $V3CreateConnectorDto + # New-CustomConnector -V3CreateConnectorDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CustomConnector" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-custom-connector Delete a custom connector that using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-custom-connector) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -136,9 +142,12 @@ try { } ``` [[Back to top]](#) + ## get-connector Fetches a connector that using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -181,9 +190,12 @@ try { } ``` [[Back to top]](#) + ## get-connector-list Fetches list of connectors that have 'RELEASED' status using filtering and pagination. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-list) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -222,7 +234,7 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale # Get Connector List try { - Get-ConnectorList + Get-ConnectorList # Below is a request that includes all optional parameters # Get-ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale @@ -232,9 +244,12 @@ try { } ``` [[Back to top]](#) + ## get-connector-source-config Fetches a connector's source config using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -275,9 +290,12 @@ try { } ``` [[Back to top]](#) + ## get-connector-source-template Fetches a connector's source template using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-source-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -318,9 +336,12 @@ try { } ``` [[Back to top]](#) + ## get-connector-translations Fetches a connector's translations using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-connector-translations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -353,7 +374,7 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale # Get Connector Translations try { - Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale # Below is a request that includes all optional parameters # Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -363,9 +384,12 @@ try { } ``` [[Back to top]](#) + ## put-connector-source-config Update a connector's source config using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -398,7 +422,7 @@ $File = # System.IO.FileInfo | connector source config xml file # Update Connector Source Configuration try { - Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File + Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File # Below is a request that includes all optional parameters # Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File @@ -408,9 +432,12 @@ try { } ``` [[Back to top]](#) + ## put-connector-source-template Update a connector's source template using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-source-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -443,7 +470,7 @@ $File = # System.IO.FileInfo | connector source template xml file # Update Connector Source Template try { - Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File + Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File # Below is a request that includes all optional parameters # Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File @@ -453,9 +480,12 @@ try { } ``` [[Back to top]](#) + ## put-connector-translations Update a connector's translations using its script name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-connector-translations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -488,7 +518,7 @@ $Locale = "de" # String | The locale to apply to the config. If no viable locale # Update Connector Translations try { - Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale # Below is a request that includes all optional parameters # Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -498,6 +528,7 @@ try { } ``` [[Back to top]](#) + ## update-connector This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. @@ -513,6 +544,8 @@ The following fields are patchable: * sourceConfigXml +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-connector) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -551,10 +584,10 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result + Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-Connector -ScriptName $ScriptName -JsonPatchOperation $JsonPatchOperation + # Update-Connector -ScriptName $ScriptName -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Connector" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md index ce9b5e0ed..b97d530c9 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md @@ -30,9 +30,12 @@ Method | HTTP request | Description [**Update-AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration [**Update-AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration + ## create-auth-org-network-config This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage' +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-auth-org-network-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -68,19 +71,22 @@ $NetworkConfiguration = @"{ try { $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration - New-AuthOrgNetworkConfig -NetworkConfiguration $Result + New-AuthOrgNetworkConfig -NetworkConfiguration $Result # Below is a request that includes all optional parameters - # New-AuthOrgNetworkConfig -NetworkConfiguration $NetworkConfiguration + # New-AuthOrgNetworkConfig -NetworkConfiguration $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-auth-org-lockout-config This API returns the details of an org's lockout auth configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-lockout-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -109,7 +115,7 @@ Code | Description | Data Type # Get Auth Org Lockout Configuration. try { - Get-AuthOrgLockoutConfig + Get-AuthOrgLockoutConfig # Below is a request that includes all optional parameters # Get-AuthOrgLockoutConfig @@ -119,9 +125,12 @@ try { } ``` [[Back to top]](#) + ## get-auth-org-network-config This API returns the details of an org's network auth configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-network-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -150,7 +159,7 @@ Code | Description | Data Type # Get security network configuration. try { - Get-AuthOrgNetworkConfig + Get-AuthOrgNetworkConfig # Below is a request that includes all optional parameters # Get-AuthOrgNetworkConfig @@ -160,9 +169,12 @@ try { } ``` [[Back to top]](#) + ## get-auth-org-service-provider-config This API returns the details of an org's service provider auth configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-service-provider-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -191,7 +203,7 @@ Code | Description | Data Type # Get Service Provider Configuration. try { - Get-AuthOrgServiceProviderConfig + Get-AuthOrgServiceProviderConfig # Below is a request that includes all optional parameters # Get-AuthOrgServiceProviderConfig @@ -201,9 +213,12 @@ try { } ``` [[Back to top]](#) + ## get-auth-org-session-config This API returns the details of an org's session auth configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-auth-org-session-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -232,7 +247,7 @@ Code | Description | Data Type # Get Auth Org Session Configuration. try { - Get-AuthOrgSessionConfig + Get-AuthOrgSessionConfig # Below is a request that includes all optional parameters # Get-AuthOrgSessionConfig @@ -242,10 +257,13 @@ try { } ``` [[Back to top]](#) + ## patch-auth-org-lockout-config This API updates an existing lockout configuration for an org using PATCH +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-lockout-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -282,20 +300,23 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AuthOrgLockoutConfig -JsonPatchOperation $Result + Update-AuthOrgLockoutConfig -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-AuthOrgLockoutConfig -JsonPatchOperation $JsonPatchOperation + # Update-AuthOrgLockoutConfig -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgLockoutConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-auth-org-network-config This API updates an existing network configuration for an org using PATCH Requires security scope of: 'sp:auth-org:manage' +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-network-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -332,19 +353,22 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AuthOrgNetworkConfig -JsonPatchOperation $Result + Update-AuthOrgNetworkConfig -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-AuthOrgNetworkConfig -JsonPatchOperation $JsonPatchOperation + # Update-AuthOrgNetworkConfig -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-auth-org-service-provider-config This API updates an existing service provider configuration for an org using PATCH. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-service-provider-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -381,19 +405,22 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result + Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-AuthOrgServiceProviderConfig -JsonPatchOperation $JsonPatchOperation + # Update-AuthOrgServiceProviderConfig -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgServiceProviderConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-auth-org-session-config This API updates an existing session configuration for an org using PATCH. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-auth-org-session-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -430,10 +457,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-AuthOrgSessionConfig -JsonPatchOperation $Result + Update-AuthOrgSessionConfig -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-AuthOrgSessionConfig -JsonPatchOperation $JsonPatchOperation + # Update-AuthOrgSessionConfig -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgSessionConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md index 9ceec34cd..1ef0b0c0c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md @@ -39,9 +39,12 @@ Method | HTTP request | Description [**Sync-IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile [**Update-IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile + ## create-identity-profile This creates an Identity Profile. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -120,16 +123,17 @@ $IdentityProfile = @"{ try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-IdentityProfile -IdentityProfile $Result + New-IdentityProfile -IdentityProfile $Result # Below is a request that includes all optional parameters - # New-IdentityProfile -IdentityProfile $IdentityProfile + # New-IdentityProfile -IdentityProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-IdentityProfile" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-identity-profile This deletes an Identity Profile based on ID. @@ -138,6 +142,8 @@ On success, this endpoint will return a reference to the bulk delete task result The following rights are required to access this endpoint: idn:identity-profile:delete +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -178,6 +184,7 @@ try { } ``` [[Back to top]](#) + ## delete-identity-profiles This deletes multiple Identity Profiles via a list of supplied IDs. @@ -185,6 +192,8 @@ On success, this endpoint will return a reference to the bulk delete task result The following rights are required to access this endpoint: idn:identity-profile:delete +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -217,19 +226,22 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-IdentityProfiles -RequestBody $Result + Remove-IdentityProfiles -RequestBody $Result # Below is a request that includes all optional parameters - # Remove-IdentityProfiles -RequestBody $RequestBody + # Remove-IdentityProfiles -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## export-identity-profiles This exports existing identity profiles in the format specified by the sp-config service. +[API Spec](https://developer.sailpoint.com/docs/api/v3/export-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -267,7 +279,7 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described # Export Identity Profiles try { - Export-IdentityProfiles + Export-IdentityProfiles # Below is a request that includes all optional parameters # Export-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters @@ -277,9 +289,12 @@ try { } ``` [[Back to top]](#) + ## get-default-identity-attribute-config This returns the default identity attribute config. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-default-identity-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -320,9 +335,12 @@ try { } ``` [[Back to top]](#) + ## get-identity-profile This returns a single Identity Profile based on ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -363,9 +381,12 @@ try { } ``` [[Back to top]](#) + ## import-identity-profiles This imports previously exported identity profiles. +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -458,19 +479,22 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-IdentityProfiles -IdentityProfileExportedObject $Result + Import-IdentityProfiles -IdentityProfileExportedObject $Result # Below is a request that includes all optional parameters - # Import-IdentityProfiles -IdentityProfileExportedObject $IdentityProfileExportedObject + # Import-IdentityProfiles -IdentityProfileExportedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-IdentityProfiles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## list-identity-profiles This returns a list of Identity Profiles based on the specified query parameters. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-profiles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -508,7 +532,7 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described # Identity Profiles List try { - Get-IdentityProfiles + Get-IdentityProfiles # Below is a request that includes all optional parameters # Get-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters @@ -518,10 +542,13 @@ try { } ``` [[Back to top]](#) + ## show-identity-preview Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/v3/show-identity-preview) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -578,16 +605,17 @@ $IdentityPreviewRequest = @"{ try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - Show-IdentityPreview -IdentityPreviewRequest $Result + Show-IdentityPreview -IdentityPreviewRequest $Result # Below is a request that includes all optional parameters - # Show-IdentityPreview -IdentityPreviewRequest $IdentityPreviewRequest + # Show-IdentityPreview -IdentityPreviewRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-IdentityPreview" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## sync-identity-profile Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. @@ -595,6 +623,8 @@ This should only be run on identity profiles that have the `identityRefreshRequi This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. +[API Spec](https://developer.sailpoint.com/docs/api/v3/sync-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -635,6 +665,7 @@ try { } ``` [[Back to top]](#) + ## update-identity-profile This updates the specified Identity Profile. @@ -648,6 +679,8 @@ Some fields of the Schema cannot be updated. These fields are listed below: * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-identity-profile) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -686,10 +719,10 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $JsonPatchOperation + # Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-IdentityProfile" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/LifecycleStatesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/LifecycleStatesApi.md index 989adbedf..d9f62ef36 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/LifecycleStatesApi.md @@ -62,9 +62,12 @@ Method | HTTP request | Description [**Set-LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State [**Update-LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + ## create-lifecycle-state Use this endpoint to create a lifecycle state. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-lifecycle-state) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -121,19 +124,22 @@ $LifecycleState = @"{ try { $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState - New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result + New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result # Below is a request that includes all optional parameters - # New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $LifecycleState + # New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-LifecycleState" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-lifecycle-state Use this endpoint to delete the lifecycle state by its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-lifecycle-state) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -166,7 +172,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat # Delete Lifecycle State try { - Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId # Below is a request that includes all optional parameters # Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -176,9 +182,12 @@ try { } ``` [[Back to top]](#) + ## get-lifecycle-state Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-state) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -211,7 +220,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat # Get Lifecycle State try { - Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId # Below is a request that includes all optional parameters # Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -221,9 +230,12 @@ try { } ``` [[Back to top]](#) + ## get-lifecycle-states Use this endpoint to list all lifecycle states by their associated identity profiles. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-lifecycle-states) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -271,9 +283,12 @@ try { } ``` [[Back to top]](#) + ## set-lifecycle-state Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-lifecycle-state) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -307,19 +322,22 @@ $SetLifecycleStateRequest = @""@ try { $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest - Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result + Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result # Below is a request that includes all optional parameters - # Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $SetLifecycleStateRequest + # Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-LifecycleState" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-lifecycle-states Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-lifecycle-states) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -360,10 +378,10 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result + Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $JsonPatchOperation + # Update-LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/MFAConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/MFAConfigurationApi.md index 4a672e389..b6ebe4f92 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/MFAConfigurationApi.md @@ -26,9 +26,12 @@ Method | HTTP request | Description [**Set-MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration [**Test-MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration + ## delete-mfa-config This API removes the configuration for the specified MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-mfa-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -68,9 +71,12 @@ try { } ``` [[Back to top]](#) + ## get-mfa-duo-config This API returns the configuration of an Duo MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-duo-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -98,7 +104,7 @@ Code | Description | Data Type # Configuration of Duo MFA method try { - Get-MFADuoConfig + Get-MFADuoConfig # Below is a request that includes all optional parameters # Get-MFADuoConfig @@ -108,9 +114,12 @@ try { } ``` [[Back to top]](#) + ## get-mfa-kba-config This API returns the KBA configuration for MFA. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-kba-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -140,7 +149,7 @@ $AllLanguages = $false # Boolean | Indicator whether the question text should be # Configuration of KBA MFA method try { - Get-MFAKbaConfig + Get-MFAKbaConfig # Below is a request that includes all optional parameters # Get-MFAKbaConfig -AllLanguages $AllLanguages @@ -150,9 +159,12 @@ try { } ``` [[Back to top]](#) + ## get-mfa-okta-config This API returns the configuration of an Okta MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-mfa-okta-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -180,7 +192,7 @@ Code | Description | Data Type # Configuration of Okta MFA method try { - Get-MFAOktaConfig + Get-MFAOktaConfig # Below is a request that includes all optional parameters # Get-MFAOktaConfig @@ -190,9 +202,12 @@ try { } ``` [[Back to top]](#) + ## set-mfa-duo-config This API sets the configuration of an Duo MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfa-duo-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -233,19 +248,22 @@ $MfaDuoConfig = @"{ try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-MFADuoConfig -MfaDuoConfig $Result + Set-MFADuoConfig -MfaDuoConfig $Result # Below is a request that includes all optional parameters - # Set-MFADuoConfig -MfaDuoConfig $MfaDuoConfig + # Set-MFADuoConfig -MfaDuoConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-mfakba-config This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfakba-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -280,19 +298,22 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-MFAKBAConfig -KbaAnswerRequestItem $Result + Set-MFAKBAConfig -KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Set-MFAKBAConfig -KbaAnswerRequestItem $KbaAnswerRequestItem + # Set-MFAKBAConfig -KbaAnswerRequestItem $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-mfa-okta-config This API sets the configuration of an Okta MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-mfa-okta-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -329,19 +350,22 @@ $MfaOktaConfig = @"{ try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-MFAOktaConfig -MfaOktaConfig $Result + Set-MFAOktaConfig -MfaOktaConfig $Result # Below is a request that includes all optional parameters - # Set-MFAOktaConfig -MfaOktaConfig $MfaOktaConfig + # Set-MFAOktaConfig -MfaOktaConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-mfa-config This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. +[API Spec](https://developer.sailpoint.com/docs/api/v3/test-mfa-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/MFAControllerApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/MFAControllerApi.md index 12f26c046..6feb943f9 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/MFAControllerApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/MFAControllerApi.md @@ -24,9 +24,12 @@ Method | HTTP request | Description [**Send-OktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method [**Send-TokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method + ## create-send-token This API send token request. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-send-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -60,19 +63,22 @@ $SendTokenRequest = @"{ try { $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest - New-SendToken -SendTokenRequest $Result + New-SendToken -SendTokenRequest $Result # Below is a request that includes all optional parameters - # New-SendToken -SendTokenRequest $SendTokenRequest + # New-SendToken -SendTokenRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## ping-verification-status This API poll the VerificationPollRequest for the specified MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v3/ping-verification-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -107,19 +113,22 @@ $VerificationPollRequest = @"{ try { $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest - Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result + Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result # Below is a request that includes all optional parameters - # Ping-VerificationStatus -Method $Method -VerificationPollRequest $VerificationPollRequest + # Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-duo-verify-request This API Authenticates the user via Duo-Web MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-duo-verify-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -153,19 +162,22 @@ $DuoVerificationRequest = @"{ try { $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest - Send-DuoVerifyRequest -DuoVerificationRequest $Result + Send-DuoVerifyRequest -DuoVerificationRequest $Result # Below is a request that includes all optional parameters - # Send-DuoVerifyRequest -DuoVerificationRequest $DuoVerificationRequest + # Send-DuoVerifyRequest -DuoVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-kba-answers This API Authenticate user in KBA MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-kba-answers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -200,19 +212,22 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Send-KbaAnswers -KbaAnswerRequestItem $Result + Send-KbaAnswers -KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Send-KbaAnswers -KbaAnswerRequestItem $KbaAnswerRequestItem + # Send-KbaAnswers -KbaAnswerRequestItem $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-okta-verify-request This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller. +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-okta-verify-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -245,19 +260,22 @@ $OktaVerificationRequest = @"{ try { $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest - Send-OktaVerifyRequest -OktaVerificationRequest $Result + Send-OktaVerifyRequest -OktaVerificationRequest $Result # Below is a request that includes all optional parameters - # Send-OktaVerifyRequest -OktaVerificationRequest $OktaVerificationRequest + # Send-OktaVerifyRequest -OktaVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## send-token-auth-request This API Authenticate user in Token MFA method. +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-token-auth-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -292,10 +310,10 @@ $TokenAuthRequest = @"{ try { $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest - Send-TokenAuthRequest -TokenAuthRequest $Result + Send-TokenAuthRequest -TokenAuthRequest $Result # Below is a request that includes all optional parameters - # Send-TokenAuthRequest -TokenAuthRequest $TokenAuthRequest + # Send-TokenAuthRequest -TokenAuthRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md index 645207ed2..d0dee0b66 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md @@ -26,10 +26,13 @@ Method | HTTP request | Description [**Get-ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients [**Update-ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client + ## create-managed-client Create a new managed client. The API returns a result that includes the managed client ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-managed-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -65,19 +68,22 @@ $ManagedClientRequest = @"{ try { $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-ManagedClient -ManagedClientRequest $Result + New-ManagedClient -ManagedClientRequest $Result # Below is a request that includes all optional parameters - # New-ManagedClient -ManagedClientRequest $ManagedClientRequest + # New-ManagedClient -ManagedClientRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-managed-client Delete an existing managed client. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -117,9 +123,12 @@ try { } ``` [[Back to top]](#) + ## get-managed-client Get managed client by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -160,9 +169,12 @@ try { } ``` [[Back to top]](#) + ## get-managed-client-status Get a managed client's status, using its ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-client-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -195,7 +207,7 @@ $Type = "CCG" # ManagedClientType | Managed client type to get status for. # Get Managed Client Status try { - Get-ManagedClientStatus -Id $Id -Type $Type + Get-ManagedClientStatus -Id $Id -Type $Type # Below is a request that includes all optional parameters # Get-ManagedClientStatus -Id $Id -Type $Type @@ -205,9 +217,12 @@ try { } ``` [[Back to top]](#) + ## get-managed-clients List managed clients. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clients) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -243,7 +258,7 @@ $Filters = 'name eq "client name"' # String | Filter results using the standard # Get Managed Clients try { - Get-ManagedClients + Get-ManagedClients # Below is a request that includes all optional parameters # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters @@ -253,9 +268,12 @@ try { } ``` [[Back to top]](#) + ## update-managed-client Update an existing managed client. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -294,10 +312,10 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedClient -Id $Id -JsonPatchOperation $Result + Update-ManagedClient -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-ManagedClient -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-ManagedClient -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClustersApi.md index a9dc53cdd..763aba38c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClustersApi.md @@ -27,10 +27,13 @@ Method | HTTP request | Description [**Send-ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration [**Update-ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster + ## create-managed-cluster Create a new Managed Cluster. The API returns a result that includes the managed cluster ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-managed-cluster) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -69,19 +72,22 @@ $ManagedClusterRequest = @"{ try { $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-ManagedCluster -ManagedClusterRequest $Result + New-ManagedCluster -ManagedClusterRequest $Result # Below is a request that includes all optional parameters - # New-ManagedCluster -ManagedClusterRequest $ManagedClusterRequest + # New-ManagedCluster -ManagedClusterRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-managed-cluster Delete an existing managed cluster. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-managed-cluster) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -123,9 +129,12 @@ try { } ``` [[Back to top]](#) + ## get-client-log-configuration Get a managed cluster's log configuration. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-client-log-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -167,9 +176,12 @@ try { } ``` [[Back to top]](#) + ## get-managed-cluster Get a managed cluster by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-cluster) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -210,9 +222,12 @@ try { } ``` [[Back to top]](#) + ## get-managed-clusters List current organization's managed clusters, based on request context. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-managed-clusters) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -248,7 +263,7 @@ $Filters = 'operational eq "operation"' # String | Filter results using the stan # Get Managed Clusters try { - Get-ManagedClusters + Get-ManagedClusters # Below is a request that includes all optional parameters # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters @@ -258,9 +273,12 @@ try { } ``` [[Back to top]](#) + ## put-client-log-configuration Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-client-log-configuration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -294,19 +312,22 @@ $PutClientLogConfigurationRequest = @""@ try { $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result # Below is a request that includes all optional parameters - # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $PutClientLogConfigurationRequest + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-managed-cluster Update an existing managed cluster. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-managed-cluster) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -345,10 +366,10 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + Update-ManagedCluster -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-ManagedCluster -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md index a3de73d5e..5f9bbcb62 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md @@ -81,9 +81,12 @@ Method | HTTP request | Description [**Deny-NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request [**Update-NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record + ## approve-non-employee-request Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -118,20 +121,23 @@ $NonEmployeeApprovalDecision = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result + Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result # Below is a request that includes all optional parameters - # Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $NonEmployeeApprovalDecision + # Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-NonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-record This request will create a non-employee record. Requires role context of `idn:nesr:create` +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -175,19 +181,22 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-NonEmployeeRecord -NonEmployeeRequestBody $Result + New-NonEmployeeRecord -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # New-NonEmployeeRecord -NonEmployeeRequestBody $NonEmployeeRequestBody + # New-NonEmployeeRecord -NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRecord" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-request This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -231,19 +240,22 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-NonEmployeeRequest -NonEmployeeRequestBody $Result + New-NonEmployeeRequest -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # New-NonEmployeeRequest -NonEmployeeRequestBody $NonEmployeeRequestBody + # New-NonEmployeeRequest -NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-source This request will create a non-employee source. Requires role context of `idn:nesr:create` +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -299,20 +311,23 @@ $NonEmployeeSourceRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result + New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result # Below is a request that includes all optional parameters - # New-NonEmployeeSource -NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody + # New-NonEmployeeSource -NonEmployeeSourceRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-non-employee-source-schema-attributes This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. Requires role context of `idn:nesr:create` +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source-schema-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -352,20 +367,23 @@ $NonEmployeeSchemaAttributeBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result # Below is a request that includes all optional parameters - # New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody + # New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-record This request will delete a non-employee record. Requires role context of `idn:nesr:delete` +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -405,9 +423,12 @@ try { } ``` [[Back to top]](#) + ## delete-non-employee-records-in-bulk This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-records-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -438,20 +459,23 @@ $DeleteNonEmployeeRecordsInBulkRequest = @""@ try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest - Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result + Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result # Below is a request that includes all optional parameters - # Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest + # Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecordsInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-non-employee-request This request will delete a non-employee request. Requires role context of `idn:nesr:delete` +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -492,11 +516,14 @@ try { } ``` [[Back to top]](#) + ## delete-non-employee-schema-attribute This end-point deletes a specific schema attribute for a non-employee source. Requires role context of `idn:nesr:delete` +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-schema-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -528,7 +555,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id # Delete a Schema Attribute for Non-Employee Source try { - Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId # Below is a request that includes all optional parameters # Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -538,9 +565,12 @@ try { } ``` [[Back to top]](#) + ## delete-non-employee-source This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -580,9 +610,12 @@ try { } ``` [[Back to top]](#) + ## delete-non-employee-source-schema-attributes This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-non-employee-source-schema-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -622,9 +655,12 @@ try { } ``` [[Back to top]](#) + ## export-non-employee-records This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` +[API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-records) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -665,9 +701,12 @@ try { } ``` [[Back to top]](#) + ## export-non-employee-source-schema-template This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` +[API Spec](https://developer.sailpoint.com/docs/api/v3/export-non-employee-source-schema-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -708,12 +747,15 @@ try { } ``` [[Back to top]](#) + ## get-non-employee-approval Gets a non-employee approval item detail. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get any approval. 2. The user owns the requested approval. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-approval) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -755,6 +797,7 @@ try { } ``` [[Back to top]](#) + ## get-non-employee-approval-summary This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or @@ -762,6 +805,8 @@ she may request a summary of all non-employee approval requests assigned to a pa 2. The current user is an approver, in which case "me" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-approval-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -801,11 +846,14 @@ try { } ``` [[Back to top]](#) + ## get-non-employee-bulk-upload-status The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. Requires role context of `idn:nesr:read` +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-bulk-upload-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -845,10 +893,13 @@ try { } ``` [[Back to top]](#) + ## get-non-employee-record This gets a non-employee record. Requires role context of `idn:nesr:read` +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -888,6 +939,7 @@ try { } ``` [[Back to top]](#) + ## get-non-employee-request This gets a non-employee request. There are two contextual uses for this endpoint: @@ -895,6 +947,8 @@ There are two contextual uses for this endpoint: can get the non-employee request for any user. 2. The user must be the owner of the non-employee request. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -935,6 +989,7 @@ try { } ``` [[Back to top]](#) + ## get-non-employee-request-summary This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or @@ -942,6 +997,8 @@ she may request a summary of all non-employee approval requests assigned to a pa 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-request-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -981,9 +1038,12 @@ try { } ``` [[Back to top]](#) + ## get-non-employee-schema-attribute This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-schema-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1015,7 +1075,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id # Get Schema Attribute Non-Employee Source try { - Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId # Below is a request that includes all optional parameters # Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -1025,6 +1085,7 @@ try { } ``` [[Back to top]](#) + ## get-non-employee-source This gets a non-employee source. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or @@ -1032,6 +1093,8 @@ she may request any source. 2. The current user is an account manager, in which case the user can only request sources that they own. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1071,10 +1134,13 @@ try { } ``` [[Back to top]](#) + ## get-non-employee-source-schema-attributes This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-non-employee-source-schema-attributes) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1115,9 +1181,12 @@ try { } ``` [[Back to top]](#) + ## import-non-employee-records-in-bulk This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-non-employee-records-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1150,7 +1219,7 @@ $Data = # System.IO.FileInfo | # Imports, or Updates, Non-Employee Records try { - Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data + Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data # Below is a request that includes all optional parameters # Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data @@ -1160,6 +1229,7 @@ try { } ``` [[Back to top]](#) + ## list-non-employee-approvals This gets a list of non-employee approval requests. There are two contextual uses for this endpoint: @@ -1167,6 +1237,8 @@ There are two contextual uses for this endpoint: can list the approvals for any approver. 2. The user owns the requested approval. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-approvals) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1206,7 +1278,7 @@ $Sorters = "created" # String | Sort results using the standard syntax described # Get List of Non-Employee Approval Requests try { - Get-NonEmployeeApprovals + Get-NonEmployeeApprovals # Below is a request that includes all optional parameters # Get-NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters @@ -1216,11 +1288,14 @@ try { } ``` [[Back to top]](#) + ## list-non-employee-records This gets a list of non-employee records. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-records) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1258,7 +1333,7 @@ $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter re # List Non-Employee Records try { - Get-NonEmployeeRecords + Get-NonEmployeeRecords # Below is a request that includes all optional parameters # Get-NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters @@ -1268,6 +1343,7 @@ try { } ``` [[Back to top]](#) + ## list-non-employee-requests This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or @@ -1275,6 +1351,8 @@ she may request a list non-employee requests assigned to a particular account ma 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-requests) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1324,6 +1402,7 @@ try { } ``` [[Back to top]](#) + ## list-non-employee-sources This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: 1. The user has the role context of `idn:nesr:read`, in which case he or @@ -1331,6 +1410,8 @@ she may request a list sources assigned to a particular account manager by passi 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-sources) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1380,6 +1461,7 @@ try { } ``` [[Back to top]](#) + ## patch-non-employee-record This request will patch a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they @@ -1387,6 +1469,8 @@ update all available fields. 2. The user is owner of the source, in this case they can only update the end date. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1425,21 +1509,24 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result + Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-non-employee-schema-attribute This end-point patches a specific schema attribute for a non-employee SourceId. Requires role context of `idn:nesr:update` +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-schema-attribute) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1480,19 +1567,22 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result + Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation + # Update-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## patch-non-employee-source patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-non-employee-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1530,19 +1620,22 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result + Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation + # Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSource" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## reject-non-employee-request This endpoint will reject an approval item request and notify user. The current user must be the requested approver. +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-non-employee-request) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1577,16 +1670,17 @@ $NonEmployeeRejectApprovalDecision = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result + Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result # Below is a request that includes all optional parameters - # Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision + # Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-NonEmployeeRequest" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-non-employee-record This request will update a non-employee record. There are two contextual uses for this endpoint: 1. The user has the role context of `idn:nesr:update`, in which case they @@ -1594,6 +1688,8 @@ update all available fields. 2. The user is owner of the source, in this case they can only update the end date. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-non-employee-record) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1640,10 +1736,10 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result + Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $NonEmployeeRequestBody + # Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/OAuthClientsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/OAuthClientsApi.md index d751bd855..9815ac2a8 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/OAuthClientsApi.md @@ -26,9 +26,12 @@ Method | HTTP request | Description [**Get-OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients [**Update-OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client + ## create-oauth-client This creates an OAuth client. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -75,19 +78,22 @@ $CreateOAuthClientRequest = @"{ try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-OauthClient -CreateOAuthClientRequest $Result + New-OauthClient -CreateOAuthClientRequest $Result # Below is a request that includes all optional parameters - # New-OauthClient -CreateOAuthClientRequest $CreateOAuthClientRequest + # New-OauthClient -CreateOAuthClientRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-OauthClient" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-oauth-client This deletes an OAuth client. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -128,9 +134,12 @@ try { } ``` [[Back to top]](#) + ## get-oauth-client This gets details of an OAuth client. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -171,9 +180,12 @@ try { } ``` [[Back to top]](#) + ## list-oauth-clients This gets a list of OAuth clients. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-oauth-clients) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -203,7 +215,7 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin # List OAuth Clients try { - Get-OauthClients + Get-OauthClients # Below is a request that includes all optional parameters # Get-OauthClients -Filters $Filters @@ -213,9 +225,12 @@ try { } ``` [[Back to top]](#) + ## patch-oauth-client This performs a targeted update to the field(s) of an OAuth client. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-oauth-client) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -254,10 +269,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-OauthClient -Id $Id -JsonPatchOperation $Result + Update-OauthClient -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-OauthClient -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-OauthClient -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-OauthClient" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordConfigurationApi.md index d497a579d..2111a54cf 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordConfigurationApi.md @@ -27,11 +27,14 @@ Method | HTTP request | Description [**Get-PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config [**Send-PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config + ## create-password-org-config This API creates the password org config. Unspecified fields will use default value. To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -67,19 +70,22 @@ $PasswordOrgConfig = @"{ try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-PasswordOrgConfig -PasswordOrgConfig $Result + New-PasswordOrgConfig -PasswordOrgConfig $Result # Below is a request that includes all optional parameters - # New-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig + # New-PasswordOrgConfig -PasswordOrgConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordOrgConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-password-org-config This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -107,7 +113,7 @@ Code | Description | Data Type # Get Password Org Config try { - Get-PasswordOrgConfig + Get-PasswordOrgConfig # Below is a request that includes all optional parameters # Get-PasswordOrgConfig @@ -117,11 +123,14 @@ try { } ``` [[Back to top]](#) + ## put-password-org-config This API updates the password org config for specified fields. Other fields will keep original value. You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-password-org-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,10 +166,10 @@ $PasswordOrgConfig = @"{ try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-PasswordOrgConfig -PasswordOrgConfig $Result + Send-PasswordOrgConfig -PasswordOrgConfig $Result # Below is a request that includes all optional parameters - # Send-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig + # Send-PasswordOrgConfig -PasswordOrgConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordOrgConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordDictionaryApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordDictionaryApi.md index c026e331a..753795083 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordDictionaryApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordDictionaryApi.md @@ -67,6 +67,7 @@ Method | HTTP request | Description [**Get-PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary [**Send-PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary + ## get-password-dictionary This gets password dictionary for the organization. The password dictionary file can contain lines that are: @@ -98,6 +99,8 @@ qazxsws ``` +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-dictionary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -126,7 +129,7 @@ Code | Description | Data Type # Get Password Dictionary try { - Get-PasswordDictionary + Get-PasswordDictionary # Below is a request that includes all optional parameters # Get-PasswordDictionary @@ -136,6 +139,7 @@ try { } ``` [[Back to top]](#) + ## put-password-dictionary This updates password dictionary for the organization. The password dictionary file can contain lines that are: @@ -167,6 +171,8 @@ qazxsws ``` +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-password-dictionary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -198,7 +204,7 @@ $File = # System.IO.FileInfo | (optional) # Update Password Dictionary try { - Send-PasswordDictionary + Send-PasswordDictionary # Below is a request that includes all optional parameters # Send-PasswordDictionary -File $File diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordManagementApi.md index 7c79f45c4..d62adbc40 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordManagementApi.md @@ -45,9 +45,12 @@ Method | HTTP request | Description [**Search-PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info [**Set-Password**](#set-password) | **POST** `/set-password` | Set Identity's Password + ## get-password-change-status This API returns the status of a password change request. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-change-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -88,10 +91,13 @@ try { } ``` [[Back to top]](#) + ## query-password-info This API is used to query password related information. +[API Spec](https://developer.sailpoint.com/docs/api/v3/query-password-info) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -125,16 +131,17 @@ $PasswordInfoQueryDTO = @"{ try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-PasswordInfo -PasswordInfoQueryDTO $Result + Search-PasswordInfo -PasswordInfoQueryDTO $Result # Below is a request that includes all optional parameters - # Search-PasswordInfo -PasswordInfoQueryDTO $PasswordInfoQueryDTO + # Search-PasswordInfo -PasswordInfoQueryDTO $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-PasswordInfo" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-password This API is used to set a password for an identity. @@ -157,6 +164,8 @@ If you are using a Windows machine, refer to this [guide](https://tecadmin.net/i You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-password) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -193,10 +202,10 @@ $PasswordChangeRequest = @"{ try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-Password -PasswordChangeRequest $Result + Set-Password -PasswordChangeRequest $Result # Below is a request that includes all optional parameters - # Set-Password -PasswordChangeRequest $PasswordChangeRequest + # Set-Password -PasswordChangeRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-Password" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordPoliciesApi.md index f8a752c8c..a67ae3397 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordPoliciesApi.md @@ -31,9 +31,12 @@ Method | HTTP request | Description [**Get-PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies [**Set-PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID + ## create-password-policy This API creates the specified password policy. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -97,19 +100,22 @@ $PasswordPolicyV3Dto = @"{ try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-PasswordPolicy -PasswordPolicyV3Dto $Result + New-PasswordPolicy -PasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters - # New-PasswordPolicy -PasswordPolicyV3Dto $PasswordPolicyV3Dto + # New-PasswordPolicy -PasswordPolicyV3Dto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-password-policy This API deletes the specified password policy. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-password-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -150,9 +156,12 @@ try { } ``` [[Back to top]](#) + ## get-password-policy-by-id This API returns the password policy for the specified ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-policy-by-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -193,10 +202,13 @@ try { } ``` [[Back to top]](#) + ## list-password-policies This gets list of all Password Policies. Requires role of ORG_ADMIN +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-password-policies) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -230,7 +242,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List Password Policies try { - Get-PasswordPolicies + Get-PasswordPolicies # Below is a request that includes all optional parameters # Get-PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count @@ -240,9 +252,12 @@ try { } ``` [[Back to top]](#) + ## set-password-policy This API updates the specified password policy. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-password-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -308,10 +323,10 @@ $PasswordPolicyV3Dto = @"{ try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result + Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters - # Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $PasswordPolicyV3Dto + # Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-PasswordPolicy" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordSyncGroupsApi.md index a9c977a99..eb9a0b4e1 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordSyncGroupsApi.md @@ -55,9 +55,12 @@ Method | HTTP request | Description [**Get-PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List [**Update-PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID + ## create-password-sync-group This API creates a password sync group based on the specifications provided. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -95,19 +98,22 @@ $PasswordSyncGroup = @"{ try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-PasswordSyncGroup -PasswordSyncGroup $Result + New-PasswordSyncGroup -PasswordSyncGroup $Result # Below is a request that includes all optional parameters - # New-PasswordSyncGroup -PasswordSyncGroup $PasswordSyncGroup + # New-PasswordSyncGroup -PasswordSyncGroup $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordSyncGroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-password-sync-group This API deletes the specified password sync group. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -147,9 +153,12 @@ try { } ``` [[Back to top]](#) + ## get-password-sync-group This API returns the sync group for the specified ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -190,9 +199,12 @@ try { } ``` [[Back to top]](#) + ## get-password-sync-groups This API returns a list of password sync groups. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-password-sync-groups) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -226,7 +238,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Get Password Sync Group List try { - Get-PasswordSyncGroups + Get-PasswordSyncGroups # Below is a request that includes all optional parameters # Get-PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count @@ -236,9 +248,12 @@ try { } ``` [[Back to top]](#) + ## update-password-sync-group This API updates the specified password sync group. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-password-sync-group) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -279,10 +294,10 @@ $PasswordSyncGroup = @"{ try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result + Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result # Below is a request that includes all optional parameters - # Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $PasswordSyncGroup + # Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PasswordSyncGroup" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PersonalAccessTokensApi.md index 089fc96a9..f43f7a699 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PersonalAccessTokensApi.md @@ -33,9 +33,12 @@ Method | HTTP request | Description [**Get-PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens [**Update-PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token + ## create-personal-access-token This creates a personal access token. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-personal-access-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -70,19 +73,22 @@ $CreatePersonalAccessTokenRequest = @"{ try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result + New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result # Below is a request that includes all optional parameters - # New-PersonalAccessToken -CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest + # New-PersonalAccessToken -CreatePersonalAccessTokenRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PersonalAccessToken" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-personal-access-token This deletes a personal access token. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-personal-access-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -123,9 +129,12 @@ try { } ``` [[Back to top]](#) + ## list-personal-access-tokens This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-personal-access-tokens) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,7 +166,7 @@ $Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results usin # List Personal Access Tokens try { - Get-PersonalAccessTokens + Get-PersonalAccessTokens # Below is a request that includes all optional parameters # Get-PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters @@ -167,10 +176,13 @@ try { } ``` [[Back to top]](#) + ## patch-personal-access-token This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-personal-access-token) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -209,10 +221,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result + Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-PersonalAccessToken -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-PersonalAccessToken -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PersonalAccessToken" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesApi.md index 4dad6e8e7..29dfe0b4c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesApi.md @@ -22,9 +22,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-PublicIdentities**](#get-public-identities) | **GET** `/public-identities` | Get list of public identities + ## get-public-identities Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-public-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -64,7 +67,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # Get list of public identities try { - Get-PublicIdentities + Get-PublicIdentities # Below is a request that includes all optional parameters # Get-PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesConfigApi.md index ca08010dc..69ec14601 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesConfigApi.md @@ -30,9 +30,12 @@ Method | HTTP request | Description [**Get-PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration [**Update-PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration + ## get-public-identity-config Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-public-identity-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -60,7 +63,7 @@ Code | Description | Data Type # Get the Public Identities Configuration try { - Get-PublicIdentityConfig + Get-PublicIdentityConfig # Below is a request that includes all optional parameters # Get-PublicIdentityConfig @@ -70,9 +73,12 @@ try { } ``` [[Back to top]](#) + ## update-public-identity-config Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-public-identity-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -117,10 +123,10 @@ $PublicIdentityConfig = @"{ try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-PublicIdentityConfig -PublicIdentityConfig $Result + Update-PublicIdentityConfig -PublicIdentityConfig $Result # Below is a request that includes all optional parameters - # Update-PublicIdentityConfig -PublicIdentityConfig $PublicIdentityConfig + # Update-PublicIdentityConfig -PublicIdentityConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PublicIdentityConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ReportsDataExtractionApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ReportsDataExtractionApi.md index ceee6a78b..a578edd48 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ReportsDataExtractionApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ReportsDataExtractionApi.md @@ -25,9 +25,12 @@ Method | HTTP request | Description [**Get-ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result [**Start-Report**](#start-report) | **POST** `/reports/run` | Run Report + ## cancel-report Cancels a running report. +[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -67,9 +70,12 @@ try { } ``` [[Back to top]](#) + ## get-report Gets a report in file format. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -106,7 +112,7 @@ $Auditable = $true # Boolean | Enables auditing for current report download. Wil # Get Report File try { - Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat + Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat # Below is a request that includes all optional parameters # Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $Auditable @@ -116,9 +122,12 @@ try { } ``` [[Back to top]](#) + ## get-report-result Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-report-result) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -160,9 +169,12 @@ try { } ``` [[Back to top]](#) + ## start-report Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -199,10 +211,10 @@ $ReportDetails = @"{ try { $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails - Start-Report -ReportDetails $Result + Start-Report -ReportDetails $Result # Below is a request that includes all optional parameters - # Start-Report -ReportDetails $ReportDetails + # Start-Report -ReportDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Report" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/RequestableObjectsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/RequestableObjectsApi.md index 5c4fe429f..19b1afed0 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/RequestableObjectsApi.md @@ -22,10 +22,13 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List + ## list-requestable-objects This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. Any authenticated token can call this endpoint to see their requestable access items. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-requestable-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -75,7 +78,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in # Requestable Objects List try { - Get-RequestableObjects + Get-RequestableObjects # Below is a request that includes all optional parameters # Get-RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md index b4d979af5..5b7efe094 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md @@ -62,12 +62,15 @@ Method | HTTP request | Description [**Get-Roles**](#list-roles) | **GET** `/roles` | List Roles [**Update-Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role + ## create-role This API creates a role. In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -255,22 +258,25 @@ $Role = @"{ try { $Result = ConvertFrom-JsonToRole -Json $Role - New-Role -Role $Result + New-Role -Role $Result # Below is a request that includes all optional parameters - # New-Role -Role $Role + # New-Role -Role $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Role" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-bulk-roles This endpoint initiates a bulk deletion of one or more roles. When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. This endpoint can only bulk delete up to a limit of 50 roles per request. A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-bulk-roles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -303,21 +309,24 @@ $RoleBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-BulkRoles -RoleBulkDeleteRequest $Result + Remove-BulkRoles -RoleBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-BulkRoles -RoleBulkDeleteRequest $RoleBulkDeleteRequest + # Remove-BulkRoles -RoleBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BulkRoles" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-role This API deletes a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -357,10 +366,13 @@ try { } ``` [[Back to top]](#) + ## get-role This API returns a Role by its ID. A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -400,9 +412,12 @@ try { } ``` [[Back to top]](#) + ## get-role-assigned-identities +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-role-assigned-identities) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -452,9 +467,12 @@ try { } ``` [[Back to top]](#) + ## list-roles This API returns a list of Roles. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-roles) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -498,7 +516,7 @@ $IncludeUnsegmented = $false # Boolean | Whether or not the response list should # List Roles try { - Get-Roles + Get-Roles # Below is a request that includes all optional parameters # Get-Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented @@ -508,6 +526,7 @@ try { } ``` [[Back to top]](#) + ## patch-role This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: @@ -530,6 +549,8 @@ The maximum supported length for the description field is 2000 characters. Longe When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-role) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -567,10 +588,10 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Role -Id $Id -JsonPatchOperation $Result + Update-Role -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-Role -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-Role -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SODPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SODPoliciesApi.md index 96de393b7..a06fff602 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SODPoliciesApi.md @@ -61,10 +61,13 @@ Method | HTTP request | Description [**Start-SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org [**Start-SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + ## create-sod-policy This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -150,20 +153,23 @@ $SodPolicy = @"{ try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-SodPolicy -SodPolicy $Result + New-SodPolicy -SodPolicy $Result # Below is a request that includes all optional parameters - # New-SodPolicy -SodPolicy $SodPolicy + # New-SodPolicy -SodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-sod-policy This deletes a specified SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -206,9 +212,12 @@ try { } ``` [[Back to top]](#) + ## delete-sod-policy-schedule This deletes schedule for a specified SOD policy by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-sod-policy-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -249,9 +258,12 @@ try { } ``` [[Back to top]](#) + ## get-custom-violation-report This allows to download a specified named violation report for a given report reference. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-custom-violation-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -284,7 +296,7 @@ $FileName = "custom-name" # String | Custom Name for the file. # Download custom violation report try { - Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName # Below is a request that includes all optional parameters # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName @@ -294,9 +306,12 @@ try { } ``` [[Back to top]](#) + ## get-default-violation-report This allows to download a violation report for a given report reference. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-default-violation-report) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -337,9 +352,12 @@ try { } ``` [[Back to top]](#) + ## get-sod-all-report-run-status This endpoint gets the status for a violation report for all policy run. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-all-report-run-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -367,7 +385,7 @@ Code | Description | Data Type # Get multi-report run task status try { - Get-SodAllReportRunStatus + Get-SodAllReportRunStatus # Below is a request that includes all optional parameters # Get-SodAllReportRunStatus @@ -377,10 +395,13 @@ try { } ``` [[Back to top]](#) + ## get-sod-policy This gets specified SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -421,9 +442,12 @@ try { } ``` [[Back to top]](#) + ## get-sod-policy-schedule This endpoint gets a specified SOD policy's schedule. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-policy-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -463,9 +487,12 @@ try { } ``` [[Back to top]](#) + ## get-sod-violation-report-run-status This gets the status for a violation report run task that has already been invoked. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-run-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -506,9 +533,12 @@ try { } ``` [[Back to top]](#) + ## get-sod-violation-report-status This gets the status for a violation report run task that has already been invoked. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-sod-violation-report-status) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -549,10 +579,13 @@ try { } ``` [[Back to top]](#) + ## list-sod-policies This gets list of all SOD policies. Requires role of ORG_ADMIN +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-sod-policies) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -590,7 +623,7 @@ $Sorters = "id,name" # String | Sort results using the standard syntax described # List SOD policies try { - Get-SodPolicies + Get-SodPolicies # Below is a request that includes all optional parameters # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters @@ -600,11 +633,14 @@ try { } ``` [[Back to top]](#) + ## patch-sod-policy Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Requires role of ORG_ADMIN. This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -643,19 +679,22 @@ $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SodPolicy -Id $Id -JsonPatchOperation $Result + Update-SodPolicy -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-SodPolicy -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-SodPolicy -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-policy-schedule This updates schedule for a specified SOD policy. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-policy-schedule) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -725,20 +764,23 @@ $SodPolicySchedule = @"{ try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + Send-PolicySchedule -Id $Id -SodPolicySchedule $Result # Below is a request that includes all optional parameters - # Send-PolicySchedule -Id $Id -SodPolicySchedule $SodPolicySchedule + # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-sod-policy This updates a specified SOD policy. Requires role of ORG_ADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -827,19 +869,22 @@ $SodPolicy = @"{ try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-SodPolicy -Id $Id -SodPolicy $Result + Send-SodPolicy -Id $Id -SodPolicy $Result # Below is a request that includes all optional parameters - # Send-SodPolicy -Id $Id -SodPolicy $SodPolicy + # Send-SodPolicy -Id $Id -SodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-evaluate-sod-policy Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-evaluate-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -879,9 +924,12 @@ try { } ``` [[Back to top]](#) + ## start-sod-all-policies-for-org Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-all-policies-for-org) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -913,19 +961,22 @@ $MultiPolicyRequest = @"{ # Runs all policies for org try { - Start-SodAllPoliciesForOrg + Start-SodAllPoliciesForOrg # Below is a request that includes all optional parameters - # Start-SodAllPoliciesForOrg -MultiPolicyRequest $MultiPolicyRequest + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-sod-policy This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-sod-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md index ba9351754..e58b77ec3 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md @@ -38,9 +38,12 @@ Method | HTTP request | Description [**Start-PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. [**Start-ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations + ## start-predict-sod-violations This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-predict-sod-violations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -83,19 +86,22 @@ $IdentityWithNewAccess = @"{ try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-PredictSodViolations -IdentityWithNewAccess $Result + Start-PredictSodViolations -IdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Start-PredictSodViolations -IdentityWithNewAccess $IdentityWithNewAccess + # Start-PredictSodViolations -IdentityWithNewAccess $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## start-violation-check This API initiates a SOD policy verification asynchronously. +[API Spec](https://developer.sailpoint.com/docs/api/v3/start-violation-check) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -127,10 +133,10 @@ $IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, access try { $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-ViolationCheck -IdentityWithNewAccess1 $Result + Start-ViolationCheck -IdentityWithNewAccess1 $Result # Below is a request that includes all optional parameters - # Start-ViolationCheck -IdentityWithNewAccess1 $IdentityWithNewAccess1 + # Start-ViolationCheck -IdentityWithNewAccess1 $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SavedSearchApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SavedSearchApi.md index 8b6cfc070..b2ce4f5d3 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SavedSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SavedSearchApi.md @@ -34,10 +34,13 @@ Method | HTTP request | Description [**Get-SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches [**Send-SavedSearch**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search + ## create-saved-search Creates a new saved search. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-saved-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -68,20 +71,23 @@ $CreateSavedSearchRequest = @""@ try { $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-SavedSearch -CreateSavedSearchRequest $Result + New-SavedSearch -CreateSavedSearchRequest $Result # Below is a request that includes all optional parameters - # New-SavedSearch -CreateSavedSearchRequest $CreateSavedSearchRequest + # New-SavedSearch -CreateSavedSearchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-saved-search Deletes the specified saved search. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-saved-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -122,10 +128,13 @@ try { } ``` [[Back to top]](#) + ## execute-saved-search Executes the specified saved search. +[API Spec](https://developer.sailpoint.com/docs/api/v3/execute-saved-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -169,20 +178,23 @@ $SearchArguments = @"{ try { $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result + Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result # Below is a request that includes all optional parameters - # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $SearchArguments + # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-saved-search Returns the specified saved search. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-saved-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -223,10 +235,13 @@ try { } ``` [[Back to top]](#) + ## list-saved-searches Returns a list of saved searches. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-saved-searches) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -262,7 +277,7 @@ $Filters = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filte # A list of Saved Searches try { - Get-SavedSearches + Get-SavedSearches # Below is a request that includes all optional parameters # Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters @@ -272,12 +287,15 @@ try { } ``` [[Back to top]](#) + ## put-saved-search Updates an existing saved search. >**NOTE: You cannot update the `owner` of the saved search.** +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-saved-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -354,10 +372,10 @@ $SavedSearch = @"{ try { $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-SavedSearch -Id $Id -SavedSearch $Result + Send-SavedSearch -Id $Id -SavedSearch $Result # Below is a request that includes all optional parameters - # Send-SavedSearch -Id $Id -SavedSearch $SavedSearch + # Send-SavedSearch -Id $Id -SavedSearch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ScheduledSearchApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ScheduledSearchApi.md index e38773314..1c18efb98 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ScheduledSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ScheduledSearchApi.md @@ -50,10 +50,13 @@ Method | HTTP request | Description [**Invoke-UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search [**Update-ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search + ## create-scheduled-search Creates a new scheduled search. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -85,20 +88,23 @@ $CreateScheduledSearchRequest = @"{savedSearchId=9c620e13-cd33-4804-a13d-403bd7b try { $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-ScheduledSearch -CreateScheduledSearchRequest $Result + New-ScheduledSearch -CreateScheduledSearchRequest $Result # Below is a request that includes all optional parameters - # New-ScheduledSearch -CreateScheduledSearchRequest $CreateScheduledSearchRequest + # New-ScheduledSearch -CreateScheduledSearchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-scheduled-search Deletes the specified scheduled search. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -139,9 +145,12 @@ try { } ``` [[Back to top]](#) + ## get-scheduled-search Returns the specified scheduled search. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -182,10 +191,13 @@ try { } ``` [[Back to top]](#) + ## list-scheduled-search Returns a list of scheduled searches. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -222,7 +234,7 @@ $Filters = 'savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"' # String | # List scheduled searches try { - Get-ScheduledSearch + Get-ScheduledSearch # Below is a request that includes all optional parameters # Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters @@ -232,10 +244,13 @@ try { } ``` [[Back to top]](#) + ## unsubscribe-scheduled-search Unsubscribes a recipient from the specified scheduled search. +[API Spec](https://developer.sailpoint.com/docs/api/v3/unsubscribe-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -269,20 +284,23 @@ $TypedReference = @"{ try { $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result # Below is a request that includes all optional parameters - # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $TypedReference + # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-scheduled-search Updates an existing scheduled search. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-scheduled-search) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -358,10 +376,10 @@ $ScheduledSearch = @"{ try { $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-ScheduledSearch -Id $Id -ScheduledSearch $Result + Update-ScheduledSearch -Id $Id -ScheduledSearch $Result # Below is a request that includes all optional parameters - # Update-ScheduledSearch -Id $Id -ScheduledSearch $ScheduledSearch + # Update-ScheduledSearch -Id $Id -ScheduledSearch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md index 77b338c64..788df00f5 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md @@ -45,9 +45,12 @@ Method | HTTP request | Description [**Search-Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID [**Search-Post**](#search-post) | **POST** `/search` | Perform Search + ## search-aggregate Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-aggregate) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -200,19 +203,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon try { $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Aggregate -Search $Result + Search-Aggregate -Search $Result # Below is a request that includes all optional parameters - # Search-Aggregate -Search $Search -Offset $Offset -Limit $Limit -Count $Count + # Search-Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-count Performs a search with a provided query and returns the count of results in the X-Total-Count header. +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-count) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -359,19 +365,22 @@ $Search = @"{ try { $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Count -Search $Result + Search-Count -Search $Result # Below is a request that includes all optional parameters - # Search-Count -Search $Search + # Search-Count -Search $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## search-get Fetches a single document from the specified index, using the specified document ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-get) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -379,12 +388,12 @@ Path | Index | **String** | True | The index from which to fetch the specifie Path | Id | **String** | True | ID of the requested document. ### Return type -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) +[**SearchDocument**](../models/search-document) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | The requested document. | SystemCollectionsHashtable +200 | The requested document. | SearchDocument 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,7 +413,7 @@ $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document # Get a Document by ID try { - Search-Get -Index $Index -Id $Id + Search-Get -Index $Index -Id $Id # Below is a request that includes all optional parameters # Search-Get -Index $Index -Id $Id @@ -414,9 +423,12 @@ try { } ``` [[Back to top]](#) + ## search-post Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. +[API Spec](https://developer.sailpoint.com/docs/api/v3/search-post) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -426,12 +438,12 @@ Param Type | Name | Data Type | Required | Description 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 -[**SystemCollectionsHashtable[]**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) +[**SearchDocument[]**](../models/search-document) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of matching documents. | SystemCollectionsHashtable[] +200 | List of matching documents. | SearchDocument[] 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 @@ -569,10 +581,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon try { $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Post -Search $Result + Search-Post -Search $Result # Below is a request that includes all optional parameters - # Search-Post -Search $Search -Offset $Offset -Limit $Limit -Count $Count + # Search-Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SearchAttributeConfigurationApi.md index 404edb4ab..1166c54aa 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SearchAttributeConfigurationApi.md @@ -41,9 +41,12 @@ Method | HTTP request | Description [**Get-SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute [**Update-SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + ## create-search-attribute-config Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -82,19 +85,22 @@ $SearchAttributeConfig = @"{ try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-SearchAttributeConfig -SearchAttributeConfig $Result + New-SearchAttributeConfig -SearchAttributeConfig $Result # Below is a request that includes all optional parameters - # New-SearchAttributeConfig -SearchAttributeConfig $SearchAttributeConfig + # New-SearchAttributeConfig -SearchAttributeConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-search-attribute-config Delete an extended attribute configuration by name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -135,9 +141,12 @@ try { } ``` [[Back to top]](#) + ## get-search-attribute-config Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -165,7 +174,7 @@ Code | Description | Data Type # List Extended Search Attributes try { - Get-SearchAttributeConfig + Get-SearchAttributeConfig # Below is a request that includes all optional parameters # Get-SearchAttributeConfig @@ -175,9 +184,12 @@ try { } ``` [[Back to top]](#) + ## get-single-search-attribute-config Get an extended attribute configuration by name. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-single-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -219,11 +231,14 @@ try { } ``` [[Back to top]](#) + ## patch-search-attribute-config Update an existing search attribute configuration. You can patch these fields: * name * displayName * applicationAttributes +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-search-attribute-config) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -262,10 +277,10 @@ $Name = "promotedMailAttribute" # String | Name of the search attribute configur try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result + Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $JsonPatchOperation + # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SegmentsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SegmentsApi.md index f0510ad46..e6cb7731b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SegmentsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SegmentsApi.md @@ -40,10 +40,13 @@ Method | HTTP request | Description [**Get-Segments**](#list-segments) | **GET** `/segments` | List Segments [**Update-Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment + ## create-segment This API creates a segment. >**Note:** Segment definitions may take time to propagate to all identities. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -97,20 +100,23 @@ $Segment = @"{ try { $Result = ConvertFrom-JsonToSegment -Json $Segment - New-Segment -Segment $Result + New-Segment -Segment $Result # Below is a request that includes all optional parameters - # New-Segment -Segment $Segment + # New-Segment -Segment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-segment This API deletes the segment specified by the given ID. >**Note:** that segment deletion may take some time to become effective. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -151,9 +157,12 @@ try { } ``` [[Back to top]](#) + ## get-segment This API returns the segment specified by the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -194,9 +203,12 @@ try { } ``` [[Back to top]](#) + ## list-segments This API returns a list of all segments. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-segments) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -230,7 +242,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List Segments try { - Get-Segments + Get-Segments # Below is a request that includes all optional parameters # Get-Segments -Limit $Limit -Offset $Offset -Count $Count @@ -240,10 +252,13 @@ try { } ``` [[Back to top]](#) + ## patch-segment Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. >**Note:** Changes to a segment may take some time to propagate to all identities. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-segment) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -279,10 +294,10 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-Segment -Id $Id -RequestBody $Result + Update-Segment -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Update-Segment -Id $Id -RequestBody $RequestBody + # Update-Segment -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md index a4a269e86..9a1bd5bf2 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md @@ -52,9 +52,12 @@ Method | HTTP request | Description [**Send-ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration [**Update-StatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + ## create-service-desk-integration Create a new Service Desk integration. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -119,19 +122,22 @@ $ServiceDeskIntegrationDto = @"{ try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-service-desk-integration Delete an existing Service Desk integration by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -172,9 +178,12 @@ try { } ``` [[Back to top]](#) + ## get-service-desk-integration Get an existing Service Desk integration by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -215,9 +224,12 @@ try { } ``` [[Back to top]](#) + ## get-service-desk-integration-template This API endpoint returns an existing Service Desk integration template by scriptName. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-template) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -258,9 +270,12 @@ try { } ``` [[Back to top]](#) + ## get-service-desk-integration-types This API endpoint returns the current list of supported Service Desk integration types. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integration-types) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -289,7 +304,7 @@ Code | Description | Data Type # List Service Desk integration types try { - Get-ServiceDeskIntegrationTypes + Get-ServiceDeskIntegrationTypes # Below is a request that includes all optional parameters # Get-ServiceDeskIntegrationTypes @@ -299,9 +314,12 @@ try { } ``` [[Back to top]](#) + ## get-service-desk-integrations Get a list of Service Desk integration objects. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-service-desk-integrations) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -340,7 +358,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # List existing Service Desk integrations try { - Get-ServiceDeskIntegrations + Get-ServiceDeskIntegrations # Below is a request that includes all optional parameters # Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count @@ -350,9 +368,12 @@ try { } ``` [[Back to top]](#) + ## get-status-check-details Get the time check configuration of queued SDIM tickets. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-status-check-details) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -381,7 +402,7 @@ Code | Description | Data Type # Get the time check configuration try { - Get-StatusCheckDetails + Get-StatusCheckDetails # Below is a request that includes all optional parameters # Get-StatusCheckDetails @@ -391,9 +412,12 @@ try { } ``` [[Back to top]](#) + ## patch-service-desk-integration Update an existing Service Desk integration by ID with a PATCH request. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -427,19 +451,22 @@ $PatchServiceDeskIntegrationRequest = @""@ try { $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result # Below is a request that includes all optional parameters - # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest + # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-service-desk-integration Update an existing Service Desk integration by ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-service-desk-integration) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -506,19 +533,22 @@ $ServiceDeskIntegrationDto = @"{ try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-status-check-details Update the time check configuration of queued SDIM tickets. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-status-check-details) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -553,10 +583,10 @@ $QueuedCheckConfigDetails = @"{ try { $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-StatusCheckDetails -QueuedCheckConfigDetails $Result + Update-StatusCheckDetails -QueuedCheckConfigDetails $Result # Below is a request that includes all optional parameters - # Update-StatusCheckDetails -QueuedCheckConfigDetails $QueuedCheckConfigDetails + # Update-StatusCheckDetails -QueuedCheckConfigDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SourceUsagesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SourceUsagesApi.md index 67d329f2d..8ea140ef1 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SourceUsagesApi.md @@ -23,9 +23,12 @@ Method | HTTP request | Description [**Get-StatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage [**Get-UsagesBySourceId**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights + ## get-status-by-source-id This API returns the status of the source usage insights setup by IDN source ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-status-by-source-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -65,9 +68,12 @@ try { } ``` [[Back to top]](#) + ## get-usages-by-source-id This API returns a summary of source usage insights for past 12 months. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-usages-by-source-id) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SourcesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SourcesApi.md index 0616a55e3..ebcae6d9e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SourcesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SourcesApi.md @@ -101,11 +101,14 @@ Method | HTTP request | Description [**Update-Source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial) [**Update-SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + ## create-provisioning-policy This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -178,19 +181,22 @@ $ProvisioningPolicyDto = @"{ try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result + New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto + # New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-source This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -305,20 +311,23 @@ $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures try { $Result = ConvertFrom-JsonToSource -Json $Source - New-Source -Source $Result + New-Source -Source $Result # Below is a request that includes all optional parameters - # New-Source -Source $Source -ProvisionAsCsv $ProvisionAsCsv + # New-Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Source" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-source-schema Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -384,19 +393,22 @@ $Schema = @"{ try { $Result = ConvertFrom-JsonToSchema -Json $Schema - New-SourceSchema -SourceId $SourceId -Schema $Result + New-SourceSchema -SourceId $SourceId -Schema $Result # Below is a request that includes all optional parameters - # New-SourceSchema -SourceId $SourceId -Schema $Schema + # New-SourceSchema -SourceId $SourceId -Schema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SourceSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-provisioning-policy Deletes the provisioning policy with the specified usage on an application. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -429,7 +441,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I # Delete Provisioning Policy by UsageType try { - Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType # Below is a request that includes all optional parameters # Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -439,10 +451,13 @@ try { } ``` [[Back to top]](#) + ## delete-source Use this API to delete a specific source in Identity Security Cloud (ISC). The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -483,9 +498,12 @@ try { } ``` [[Back to top]](#) + ## delete-source-schema +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -518,7 +536,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. # Delete Source Schema by ID try { - Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId # Below is a request that includes all optional parameters # Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -528,10 +546,13 @@ try { } ``` [[Back to top]](#) + ## get-accounts-schema This API downloads the CSV schema that defines the account attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-accounts-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -572,11 +593,14 @@ try { } ``` [[Back to top]](#) + ## get-entitlements-schema This API downloads the CSV schema that defines the entitlement attributes on a source. >**NOTE: This API is designated only for Delimited File sources.** +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-entitlements-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -619,9 +643,12 @@ try { } ``` [[Back to top]](#) + ## get-provisioning-policy This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -654,7 +681,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I # Get Provisioning Policy by UsageType try { - Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType # Below is a request that includes all optional parameters # Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -664,9 +691,12 @@ try { } ``` [[Back to top]](#) + ## get-source Use this API to get a source by a specified ID in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -707,9 +737,12 @@ 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/v3/get-source-connections) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -750,9 +783,12 @@ try { } ``` [[Back to top]](#) + ## get-source-health This endpoint fetches source health by source's id +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-health) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -793,10 +829,13 @@ try { } ``` [[Back to top]](#) + ## get-source-schema Get the Source Schema by ID in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -829,7 +868,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. # Get Source Schema by ID try { - Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId # Below is a request that includes all optional parameters # Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -839,9 +878,12 @@ try { } ``` [[Back to top]](#) + ## get-source-schemas Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-source-schemas) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -886,6 +928,7 @@ try { } ``` [[Back to top]](#) + ## import-accounts-schema This API uploads a source schema template file to configure a source's account attributes. @@ -895,6 +938,8 @@ Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Imp >**NOTE: This API is designated only for Delimited File sources.** +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-accounts-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -936,9 +981,12 @@ try { } ``` [[Back to top]](#) + ## import-connector-file This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-connector-file) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -980,6 +1028,7 @@ try { } ``` [[Back to top]](#) + ## import-entitlements-schema This API uploads a source schema template file to configure a source's entitlement attributes. @@ -989,6 +1038,8 @@ Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Imp >**NOTE: This API is designated only for Delimited File sources.** +[API Spec](https://developer.sailpoint.com/docs/api/v3/import-entitlements-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1032,9 +1083,12 @@ try { } ``` [[Back to top]](#) + ## list-provisioning-policies This end-point lists all the ProvisioningPolicies in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-provisioning-policies) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1075,9 +1129,12 @@ try { } ``` [[Back to top]](#) + ## list-sources This end-point lists all the sources in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-sources) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1120,7 +1177,7 @@ $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the resp # Lists all sources in IdentityNow. try { - Get-Sources + Get-Sources # Below is a request that includes all optional parameters # Get-Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource @@ -1130,11 +1187,14 @@ try { } ``` [[Back to top]](#) + ## put-provisioning-policy This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1209,16 +1269,17 @@ $ProvisioningPolicyDto = @"{ try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result + Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $ProvisioningPolicyDto + # Send-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-source Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. @@ -1234,6 +1295,8 @@ These fields are immutable, so they cannot be changed: Attempts to modify these fields will result in a 400 error. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1349,16 +1412,17 @@ $Source = @"{ try { $Result = ConvertFrom-JsonToSource -Json $Source - Send-Source -Id $Id -Source $Result + Send-Source -Id $Id -Source $Result # Below is a request that includes all optional parameters - # Send-Source -Id $Id -Source $Source + # Send-Source -Id $Id -Source $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Source" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-source-schema This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. @@ -1372,6 +1436,8 @@ Any attempt to modify these fields will result in an error response with a statu > `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1440,19 +1506,22 @@ $Schema = @"{ try { $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result + Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result # Below is a request that includes all optional parameters - # Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Schema + # Send-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SourceSchema" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-provisioning-policies-in-bulk This end-point updates a list of provisioning policies on the specified source in IdentityNow. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-provisioning-policies-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1526,21 +1595,24 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result + Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto + # Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPoliciesInBulk" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-provisioning-policy This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-provisioning-policy) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1581,16 +1653,17 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result + Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $JsonPatchOperation + # Update-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPolicy" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-source Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. @@ -1609,6 +1682,8 @@ These fields are immutable, so they cannot be changed: Attempts to modify these fields will result in a 400 error. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-source) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1647,16 +1722,17 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Source -Id $Id -JsonPatchOperation $Result + Update-Source -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-Source -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-Source -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Source" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## update-source-schema Use this API to selectively update an existing Schema using a JSONPatch payload. @@ -1689,6 +1765,8 @@ To switch an account attribute to a group entitlement, you need to have the foll ``` +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-source-schema) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -1729,10 +1807,10 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result + Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $JsonPatchOperation + # Update-SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/TaggedObjectsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/TaggedObjectsApi.md index 68d14aac5..e3be7437d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/TaggedObjectsApi.md @@ -79,9 +79,12 @@ Method | HTTP request | Description [**Set-TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object [**Set-TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects + ## delete-tagged-object Delete all tags from a tagged object. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-tagged-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -113,7 +116,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to dele # Delete Object Tags try { - Remove-TaggedObject -Type $Type -Id $Id + Remove-TaggedObject -Type $Type -Id $Id # Below is a request that includes all optional parameters # Remove-TaggedObject -Type $Type -Id $Id @@ -123,9 +126,12 @@ try { } ``` [[Back to top]](#) + ## delete-tags-to-many-object This API removes tags from multiple objects. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-tags-to-many-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -167,19 +173,22 @@ $BulkRemoveTaggedObject = @"{ try { $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject - Remove-TagsToManyObject -BulkRemoveTaggedObject $Result + Remove-TagsToManyObject -BulkRemoveTaggedObject $Result # Below is a request that includes all optional parameters - # Remove-TagsToManyObject -BulkRemoveTaggedObject $BulkRemoveTaggedObject + # Remove-TagsToManyObject -BulkRemoveTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TagsToManyObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-tagged-object This gets a tagged object for the specified type. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-tagged-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -211,7 +220,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object referen # Get Tagged Object try { - Get-TaggedObject -Type $Type -Id $Id + Get-TaggedObject -Type $Type -Id $Id # Below is a request that includes all optional parameters # Get-TaggedObject -Type $Type -Id $Id @@ -221,11 +230,14 @@ try { } ``` [[Back to top]](#) + ## list-tagged-objects This API returns a list of all tagged objects. Any authenticated token may be used to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-tagged-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -261,7 +273,7 @@ $Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standar # List Tagged Objects try { - Get-TaggedObjects + Get-TaggedObjects # Below is a request that includes all optional parameters # Get-TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters @@ -271,11 +283,14 @@ try { } ``` [[Back to top]](#) + ## list-tagged-objects-by-type This API returns a list of all tagged objects by type. Any authenticated token may be used to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-tagged-objects-by-type) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -323,9 +338,12 @@ try { } ``` [[Back to top]](#) + ## put-tagged-object This updates a tagged object for the specified type. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-tagged-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -367,21 +385,24 @@ $TaggedObject = @"{ try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result + Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result # Below is a request that includes all optional parameters - # Send-TaggedObject -Type $Type -Id $Id -TaggedObject $TaggedObject + # Send-TaggedObject -Type $Type -Id $Id -TaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TaggedObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-tag-to-object This adds a tag to an object. Any authenticated token may be used to call this API. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-tag-to-object) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -419,19 +440,22 @@ $TaggedObject = @"{ try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-TagToObject -TaggedObject $Result + Set-TagToObject -TaggedObject $Result # Below is a request that includes all optional parameters - # Set-TagToObject -TaggedObject $TaggedObject + # Set-TagToObject -TaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagToObject" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## set-tags-to-many-objects This API adds tags to multiple objects. +[API Spec](https://developer.sailpoint.com/docs/api/v3/set-tags-to-many-objects) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -474,10 +498,10 @@ $BulkAddTaggedObject = @"{ try { $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject - Set-TagsToManyObjects -BulkAddTaggedObject $Result + Set-TagsToManyObjects -BulkAddTaggedObject $Result # Below is a request that includes all optional parameters - # Set-TagsToManyObjects -BulkAddTaggedObject $BulkAddTaggedObject + # Set-TagsToManyObjects -BulkAddTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagsToManyObjects" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/TransformsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/TransformsApi.md index 0a8b5890a..f3c087b14 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/TransformsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/TransformsApi.md @@ -29,9 +29,12 @@ Method | HTTP request | Description [**Get-Transforms**](#list-transforms) | **GET** `/transforms` | List transforms [**Update-Transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform + ## create-transform Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -83,19 +86,22 @@ $Transform = @"{ try { $Result = ConvertFrom-JsonToTransform -Json $Transform - New-Transform -Transform $Result + New-Transform -Transform $Result # Below is a request that includes all optional parameters - # New-Transform -Transform $Transform + # New-Transform -Transform $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Transform" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-transform Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -136,9 +142,12 @@ try { } ``` [[Back to top]](#) + ## get-transform This API returns the transform specified by the given ID. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -179,9 +188,12 @@ try { } ``` [[Back to top]](#) + ## list-transforms Gets a list of all saved transform objects. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-transforms) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -220,7 +232,7 @@ $Filters = 'name eq "Uppercase"' # String | Filter results using the standard sy # List transforms try { - Get-Transforms + Get-Transforms # Below is a request that includes all optional parameters # Get-Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters @@ -230,9 +242,12 @@ try { } ``` [[Back to top]](#) + ## update-transform Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. +[API Spec](https://developer.sailpoint.com/docs/api/v3/update-transform) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -288,7 +303,7 @@ try { Update-Transform -Id $Id # Below is a request that includes all optional parameters - # Update-Transform -Id $Id -Transform $Transform + # Update-Transform -Id $Id -Transform $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Transform" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/VendorConnectorMappingsApi.md index 4e8c1b948..5f9c0f47c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/VendorConnectorMappingsApi.md @@ -21,10 +21,13 @@ Method | HTTP request | Description [**Remove-VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping [**Get-VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings + ## create-vendor-connector-mapping Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-vendor-connector-mapping) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -78,20 +81,23 @@ $VendorConnectorMapping = @"{ try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-VendorConnectorMapping -VendorConnectorMapping $Result + New-VendorConnectorMapping -VendorConnectorMapping $Result # Below is a request that includes all optional parameters - # New-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping + # New-VendorConnectorMapping -VendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-VendorConnectorMapping" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## delete-vendor-connector-mapping Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-vendor-connector-mapping) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -145,20 +151,23 @@ $VendorConnectorMapping = @"{ try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-VendorConnectorMapping -VendorConnectorMapping $Result + Remove-VendorConnectorMapping -VendorConnectorMapping $Result # Below is a request that includes all optional parameters - # Remove-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping + # Remove-VendorConnectorMapping -VendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-VendorConnectorMapping" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## get-vendor-connector-mappings Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-vendor-connector-mappings) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -187,7 +196,7 @@ Code | Description | Data Type # List Vendor Connector Mappings try { - Get-VendorConnectorMappings + Get-VendorConnectorMappings # Below is a request that includes all optional parameters # Get-VendorConnectorMappings diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkItemsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkItemsApi.md index ea8d5ec97..b2d8726fc 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkItemsApi.md @@ -45,9 +45,12 @@ Method | HTTP request | Description [**Send-WorkItemForward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item [**Submit-AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections + ## approve-approval-item This API approves an Approval Item. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -80,7 +83,7 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap # Approve an Approval Item try { - Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -90,9 +93,12 @@ try { } ``` [[Back to top]](#) + ## approve-approval-items-in-bulk This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v3/approve-approval-items-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -133,9 +139,12 @@ try { } ``` [[Back to top]](#) + ## complete-work-item This API completes a work item. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v3/complete-work-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -176,9 +185,12 @@ try { } ``` [[Back to top]](#) + ## get-completed-work-items This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-completed-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -214,7 +226,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon # Completed Work Items try { - Get-CompletedWorkItems + Get-CompletedWorkItems # Below is a request that includes all optional parameters # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count @@ -224,9 +236,12 @@ try { } ``` [[Back to top]](#) + ## get-count-completed-work-items This gets a count of completed work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-completed-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -256,7 +271,7 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own # Count Completed Work Items try { - Get-CountCompletedWorkItems + Get-CountCompletedWorkItems # Below is a request that includes all optional parameters # Get-CountCompletedWorkItems -OwnerId $OwnerId @@ -266,9 +281,12 @@ try { } ``` [[Back to top]](#) + ## get-count-work-items This gets a count of work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-count-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -298,7 +316,7 @@ $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item own # Count Work Items try { - Get-CountWorkItems + Get-CountWorkItems # Below is a request that includes all optional parameters # Get-CountWorkItems -OwnerId $OwnerId @@ -308,9 +326,12 @@ try { } ``` [[Back to top]](#) + ## get-work-item This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -350,9 +371,12 @@ try { } ``` [[Back to top]](#) + ## get-work-items-summary This gets a summary of work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-work-items-summary) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -382,7 +406,7 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own # Work Items Summary try { - Get-WorkItemsSummary + Get-WorkItemsSummary # Below is a request that includes all optional parameters # Get-WorkItemsSummary -OwnerId $OwnerId @@ -392,9 +416,12 @@ try { } ``` [[Back to top]](#) + ## list-work-items This gets a collection of work items belonging to either the specified user(admin required), or the current user. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-work-items) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -430,7 +457,7 @@ $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item own # List Work Items try { - Get-WorkItems + Get-WorkItems # Below is a request that includes all optional parameters # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId @@ -440,9 +467,12 @@ try { } ``` [[Back to top]](#) + ## reject-approval-item This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-item) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -475,7 +505,7 @@ $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the ap # Reject an Approval Item try { - Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -485,9 +515,12 @@ try { } ``` [[Back to top]](#) + ## reject-approval-items-in-bulk This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v3/reject-approval-items-in-bulk) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -528,9 +561,12 @@ try { } ``` [[Back to top]](#) + ## send-work-item-forward This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN. +[API Spec](https://developer.sailpoint.com/docs/api/v3/send-work-item-forward) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -567,19 +603,22 @@ $WorkItemForward = @"{ try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-WorkItemForward -Id $Id -WorkItemForward $Result + Send-WorkItemForward -Id $Id -WorkItemForward $Result # Below is a request that includes all optional parameters - # Send-WorkItemForward -Id $Id -WorkItemForward $WorkItemForward + # Send-WorkItemForward -Id $Id -WorkItemForward $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## submit-account-selection This API submits account selections. Either an admin, or the owning/current user must make this request. +[API Spec](https://developer.sailpoint.com/docs/api/v3/submit-account-selection) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -613,10 +652,10 @@ $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Sele try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-AccountSelection -Id $Id -RequestBody $Result + Submit-AccountSelection -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Submit-AccountSelection -Id $Id -RequestBody $RequestBody + # Submit-AccountSelection -Id $Id -RequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md index 6ffbc495f..96440cd8a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md @@ -37,9 +37,12 @@ Method | HTTP request | Description [**Test-ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger [**Test-Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id + ## cancel-workflow-execution Use this API to cancel a running workflow execution. +[API Spec](https://developer.sailpoint.com/docs/api/v3/cancel-workflow-execution) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -80,9 +83,12 @@ try { } ``` [[Back to top]](#) + ## create-external-execute-workflow This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-external-execute-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -117,16 +123,19 @@ try { New-ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest + # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-workflow Create a new workflow with the desired trigger and steps specified in the request body. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -157,19 +166,22 @@ $CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568 try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-Workflow -CreateWorkflowRequest $Result + New-Workflow -CreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # New-Workflow -CreateWorkflowRequest $CreateWorkflowRequest + # New-Workflow -CreateWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## create-workflow-external-trigger Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. +[API Spec](https://developer.sailpoint.com/docs/api/v3/create-workflow-external-trigger) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -209,9 +221,12 @@ try { } ``` [[Back to top]](#) + ## delete-workflow Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. +[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -251,9 +266,12 @@ try { } ``` [[Back to top]](#) + ## get-workflow Get a single workflow by id. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -293,9 +311,12 @@ try { } ``` [[Back to top]](#) + ## get-workflow-execution Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -336,9 +357,12 @@ try { } ``` [[Back to top]](#) + ## get-workflow-execution-history Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution-history) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -379,6 +403,7 @@ try { } ``` [[Back to top]](#) + ## get-workflow-executions Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: 1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. @@ -392,6 +417,8 @@ Use this API to list a specified workflow's executions. Workflow executions are For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. +[API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-executions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -440,9 +467,12 @@ try { } ``` [[Back to top]](#) + ## list-complete-workflow-library This lists all triggers, actions, and operators in the library +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-complete-workflow-library) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -474,7 +504,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l # List Complete Workflow Library try { - Get-CompleteWorkflowLibrary + Get-CompleteWorkflowLibrary # Below is a request that includes all optional parameters # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset @@ -484,9 +514,12 @@ try { } ``` [[Back to top]](#) + ## list-workflow-library-actions This lists the workflow actions available to you. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-actions) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -520,7 +553,7 @@ $Filters = 'id eq "sp:create-campaign"' # String | Filter results using the stan # List Workflow Library Actions try { - Get-WorkflowLibraryActions + Get-WorkflowLibraryActions # Below is a request that includes all optional parameters # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters @@ -530,9 +563,12 @@ try { } ``` [[Back to top]](#) + ## list-workflow-library-operators This lists the workflow operators available to you +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-operators) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -560,7 +596,7 @@ Code | Description | Data Type # List Workflow Library Operators try { - Get-WorkflowLibraryOperators + Get-WorkflowLibraryOperators # Below is a request that includes all optional parameters # Get-WorkflowLibraryOperators @@ -570,9 +606,12 @@ try { } ``` [[Back to top]](#) + ## list-workflow-library-triggers This lists the workflow triggers available to you +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflow-library-triggers) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -606,7 +645,7 @@ $Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results u # List Workflow Library Triggers try { - Get-WorkflowLibraryTriggers + Get-WorkflowLibraryTriggers # Below is a request that includes all optional parameters # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters @@ -616,9 +655,12 @@ try { } ``` [[Back to top]](#) + ## list-workflows List all workflows in the tenant. +[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflows) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -646,7 +688,7 @@ Code | Description | Data Type # List Workflows try { - Get-Workflows + Get-Workflows # Below is a request that includes all optional parameters # Get-Workflows @@ -656,9 +698,12 @@ try { } ``` [[Back to top]](#) + ## patch-workflow Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +[API Spec](https://developer.sailpoint.com/docs/api/v3/patch-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -696,19 +741,22 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Workflow -Id $Id -JsonPatchOperation $Result + Update-Workflow -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-Workflow -Id $Id -JsonPatchOperation $JsonPatchOperation + # Update-Workflow -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## put-workflow Perform a full update of a workflow. The updated workflow object is returned in the response. +[API Spec](https://developer.sailpoint.com/docs/api/v3/put-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -779,19 +827,22 @@ $WorkflowBody = @"{ try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-Workflow -Id $Id -WorkflowBody $Result + Send-Workflow -Id $Id -WorkflowBody $Result # Below is a request that includes all optional parameters - # Send-Workflow -Id $Id -WorkflowBody $WorkflowBody + # Send-Workflow -Id $Id -WorkflowBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-external-execute-workflow Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. +[API Spec](https://developer.sailpoint.com/docs/api/v3/test-external-execute-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -826,18 +877,21 @@ try { Test-ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest + # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) + ## test-workflow Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. **This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** +[API Spec](https://developer.sailpoint.com/docs/api/v3/test-workflow) + ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- @@ -870,10 +924,10 @@ $TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b, try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-Workflow -Id $Id -TestWorkflowRequest $Result + Test-Workflow -Id $Id -TestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Test-Workflow -Id $Id -TestWorkflowRequest $TestWorkflowRequest + # Test-Workflow -Id $Id -TestWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/index.md b/docs/tools/sdk/powershell/Reference/V3/Methods/index.md index 3f152ea56..c8c6ea4db 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/index.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/index.md @@ -11,7 +11,6 @@ tags: ['SDK', 'Software Development Kit', 'v3', 'methods'] --- Method documents provide detailed information about each API operation (or method). They describe what the method does and details its input parameters, expected return values, and any considerations to be aware of when using it. - ## Key Features - Purpose & Overview: Explains the purpose of the method and its role in the API. - Parameters: Describe the required input parameters, including their data types. diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md index 35c8a92f6..3b9cae031 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AggregationResult.md b/docs/tools/sdk/powershell/Reference/V3/Models/AggregationResult.md index 46a6997a7..bcea62fde 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AggregationResult.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AggregationResult.md @@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'AggregationResul Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Aggregations** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional] -**Hits** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The results of the aggregation search query. | [optional] +**Hits** | [**[]SearchDocument**](search-document) | The results of the aggregation search query. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md index 8e5163d9a..c939a69ea 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **Description** | **String** | The description of the saved search. | [optional] **Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional] **Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional] -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required] **Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] **Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] **Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index bb9eb8a13..4ec75bd70 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeReq -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/PendingApproval.md b/docs/tools/sdk/powershell/Reference/V3/Models/PendingApproval.md index f81d5a65a..2ac08cc19 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/PendingApproval.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/PendingApproval.md @@ -17,6 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'PendingApproval'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **String** | The approval id. | [optional] +**AccessRequestId** | **String** | This is the access request id. | [optional] **Name** | **String** | The name of the approval. | [optional] **Created** | **System.DateTime** | When the approval was created. | [optional] **Modified** | **System.DateTime** | When the approval was modified last time. | [optional] @@ -41,6 +42,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $PendingApproval = Initialize-PSSailpoint.V3PendingApproval -Id id12345 ` + -AccessRequestId 2b838de9db9babcfe646d4f274ad4238 ` -Name aName ` -Created 2017-07-11T18:45:37.098Z ` -Modified 2018-07-25T20:22:28.104Z ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ReportDetailsArguments.md b/docs/tools/sdk/powershell/Reference/V3/Models/ReportDetailsArguments.md index d8db034e8..b2950ee29 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ReportDetailsArguments.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ReportDetailsArguments.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false] **AuthoritativeSource** | **String** | Source ID. | [required] **SelectedFormats** | **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] **Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] **Columns** | **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] **Sort** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md index 529820900..094f192a7 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md @@ -20,7 +20,7 @@ Name | Type | Description | Notes **Description** | **String** | The description of the saved search. | [optional] **Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional] **Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional] -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required] **Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] **Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] **Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md index f41b57ea6..094cdbcc6 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional] **Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional] -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. | [required] **Columns** | [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] **Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] **Fields** | **[]String** | The fields to be searched against in a multi-field query. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Search.md b/docs/tools/sdk/powershell/Reference/V3/Models/Search.md index 85955b705..d0ee77ddd 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Search.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Search.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Search', 'Search'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] **QueryType** | [**QueryType**](query-type) | | [optional] **QueryVersion** | **String** | | [optional] **Query** | [**Query**](query) | | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SearchDocument.md b/docs/tools/sdk/powershell/Reference/V3/Models/SearchDocument.md new file mode 100644 index 000000000..dc3d75fe4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SearchDocument.md @@ -0,0 +1,169 @@ +--- +id: search-document +title: SearchDocument +pagination_label: SearchDocument +sidebar_label: SearchDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchDocument', 'SearchDocument'] +slug: /tools/sdk/powershell/v3/models/search-document +tags: ['SDK', 'Software Development Kit', 'SearchDocument', 'SearchDocument'] +--- + + +# SearchDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the referenced object. | [required] +**Name** | **String** | The human readable name of the referenced object. | [required] +**Description** | **String** | Access item's description. | [optional] +**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional] +**Enabled** | **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false] +**Requestable** | **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true] +**RequestCommentsRequired** | **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false] +**Owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional] +**Type** | [**DocumentType**](document-type) | | [required] +**Source** | [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] +**Entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional] +**EntitlementCount** | **Int32** | Number of entitlements included with the role. | [optional] +**Tags** | **[]String** | Tags that have been applied to the object. | [optional] +**Action** | **String** | Name of the event as it's displayed in audit reports. | [optional] +**Stage** | **String** | Activity's current stage. | [optional] +**Origin** | **String** | Activity's origin. | [optional] +**Status** | **String** | Identity's status in SailPoint. | [optional] +**Requester** | [**AccountSource**](account-source) | | [optional] +**Recipient** | [**AccountSource**](account-source) | | [optional] +**TrackingNumber** | **String** | ID of the group of events. | [optional] +**Errors** | **[]String** | Errors provided by the source while completing account actions. | [optional] +**Warnings** | **[]String** | Warnings provided by the source while completing account actions. | [optional] +**Approvals** | [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional] +**OriginalRequests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional] +**ExpansionItems** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional] +**AccountRequests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional] +**Sources** | **String** | Sources involved in the account activity. | [optional] +**DisplayName** | **String** | Identity's display name. | [optional] +**Segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**SegmentCount** | **Int32** | Number of segments with the role. | [optional] +**CloudGoverned** | **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false] +**Privileged** | **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false] +**IdentityCount** | **Int32** | Number of identities who have access to the entitlement. | [optional] +**Type** | **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | **String** | Name of the actor that generated the event. | [optional] +**Target** | **String** | Name of the target, or recipient, of the event. | [optional] +**Stack** | **String** | The event's stack. | [optional] +**IpAddress** | **String** | Target system's IP address. | [optional] +**Details** | **String** | ID of event's details. | [optional] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional] +**Objects** | **[]String** | Objects the event is happening to. | [optional] +**Operation** | **String** | Operation, or action, performed during the event. | [optional] +**TechnicalName** | **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] +**FirstName** | **String** | Identity's first name. | [optional] +**LastName** | **String** | Identity's last name. | [optional] +**Email** | **String** | Identity's primary email address. | [optional] +**Phone** | **String** | Identity's phone number. | [optional] +**Inactive** | **Boolean** | Indicates whether the identity is inactive. | [optional] [default to $false] +**Protected** | **Boolean** | Indicates whether the identity is protected. | [optional] [default to $false] +**EmployeeNumber** | **String** | Identity's employee number. | [optional] +**Manager** | [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] +**IsManager** | **Boolean** | Indicates whether the identity is a manager of other identities. | [optional] +**IdentityProfile** | [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] +**ProcessingState** | **String** | Identity's processing state. | [optional] +**ProcessingDetails** | [**ProcessingDetails**](processing-details) | | [optional] +**Accounts** | [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] +**AccountCount** | **Int32** | Number of accounts associated with the identity. | [optional] +**Apps** | [**[]App**](app) | List of applications the identity has access to. | [optional] +**AppCount** | **Int32** | Number of applications the identity has access to. | [optional] +**Access** | [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] +**AccessCount** | **Int32** | Number of access items assigned to the identity. | [optional] +**RoleCount** | **Int32** | Number of roles assigned to the identity. | [optional] +**AccessProfileCount** | **Int32** | Number of access profiles included with the role. | [optional] +**Owns** | [**[]Owns**](owns) | Access items the identity owns. | [optional] +**OwnsCount** | **Int32** | Number of access items the identity owns. | [optional] +**AccessProfiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchDocument = Initialize-PSSailpoint.V3SearchDocument -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Description The admin role ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced 2018-06-25T20:22:33.104Z ` + -Enabled true ` + -Requestable true ` + -RequestCommentsRequired false ` + -Owner null ` + -Type null ` + -Source null ` + -Entitlements null ` + -EntitlementCount 3 ` + -Tags [TAG_1, TAG_2] ` + -Action update ` + -Stage Completed ` + -Origin null ` + -Status UNREGISTERED ` + -Requester null ` + -Recipient null ` + -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` + -Errors null ` + -Warnings null ` + -Approvals null ` + -OriginalRequests null ` + -ExpansionItems null ` + -AccountRequests null ` + -Sources smartsheet-test, airtable-v4, IdentityNow ` + -DisplayName Carol.Adams ` + -Segments null ` + -SegmentCount 1 ` + -CloudGoverned false ` + -Privileged false ` + -IdentityCount 3 ` + -Type SYSTEM_CONFIG ` + -Actor System ` + -Target Carol.Adams ` + -Stack tpe ` + -IpAddress 52.52.97.85 ` + -Details 73b65dfbed1842548c207432a18c84b0 ` + -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` + -Objects null ` + -Operation REQUEST ` + -TechnicalName AUTHENTICATION_REQUEST_PASSED ` + -FirstName Carol ` + -LastName Adams ` + -Email Carol.Adams@sailpointdemo.com ` + -Phone +1 440-527-3672 ` + -Inactive false ` + -Protected false ` + -EmployeeNumber 1a2a3d4e ` + -Manager null ` + -IsManager false ` + -IdentityProfile null ` + -ProcessingState null ` + -ProcessingDetails null ` + -Accounts null ` + -AccountCount 3 ` + -Apps null ` + -AppCount 2 ` + -Access null ` + -AccessCount 5 ` + -RoleCount 1 ` + -AccessProfileCount 1 ` + -Owns null ` + -OwnsCount 5 ` + -AccessProfiles null +``` + +- Convert the resource to JSON +```powershell +$SearchDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SearchExportReportArguments.md b/docs/tools/sdk/powershell/Reference/V3/Models/SearchExportReportArguments.md index 322cb642f..20571f801 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SearchExportReportArguments.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SearchExportReportArguments.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'Search Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Indices** | [**[]Index**](Indices) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] **Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] **Columns** | **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] **Sort** | **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md index 0328c565b..92919ac01 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/index.md b/docs/tools/sdk/powershell/Reference/V3/Models/index.md index 652b4ad72..3cad3f8ac 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/index.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/index.md @@ -10,10 +10,9 @@ slug: /tools/sdk/powershell/v3/models tags: ['SDK', 'Software Development Kit', 'v3', 'models'] --- -The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. - +The PowerShell SDK uses data models to structure and manage data within the API. These models provide essential details about the data, including their attributes, data types, and how the models relate to each other. Understanding these models is crucial to effectively interact with the API. ## Key Features - Attributes: Describe each attribute, including its name, data type, and whether it's required. - Validation & Constraints: Highlight any rules or limitations for the attributes, such as format or length limits. -- Example: Provides a sample of how the API uses the model. +- Example: Provides a sample of how the API uses the model. \ No newline at end of file diff --git a/static/code-examples/beta/code_examples_overlay.yaml b/static/code-examples/beta/code_examples_overlay.yaml index 8b1507e24..501178c6b 100644 --- a/static/code-examples/beta/code_examples_overlay.yaml +++ b/static/code-examples/beta/code_examples_overlay.yaml @@ -803,29 +803,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $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) - $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) - $Sorters = "-date" # 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: **date** (optional) - - # Returns account usage insights - - try { - Get-BetaUsagesByAccountId-BetaAccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesByAccountId -BetaAccountId $AccountId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /accounts method: POST xCodeSample: @@ -1198,6 +1175,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $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) + $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) + $Sorters = "-date" # 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: **date** (optional) + + # Returns account usage insights + + try { + Get-BetaUsagesByAccountId-BetaAccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesByAccountId -BetaAccountId $AccountId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /discovered-applications/{id} method: GET xCodeSample: @@ -6512,6 +6512,162 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" Write-Host $_.ErrorDetails } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to get + $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get + + # Specified Managed Client Status. + + try { + Get-BetaManagedClientStatus-BetaId $Id -BetaType $Type + + # Below is a request that includes all optional parameters + # Get-BetaManagedClientStatus -BetaId $Id -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to update + $ManagedClientStatus = @" + { + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } + "@ + + # Handle status request from client + + try { + $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus + Update-BetaManagedClientStatus-BetaId $Id -BetaManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -BetaId $Id -BetaManagedClientStatus $ManagedClientStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for + + # Get managed cluster's log configuration + + try { + Get-BetaClientLogConfiguration-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaClientLogConfiguration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster + source: | + $Id = "aClusterId" # String | ID of the ManagedCluster to get + + # Get a specified ManagedCluster. + + try { + Get-BetaManagedCluster-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaManagedCluster -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters + source: | + $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) + $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) + $Filters = "operational eq operation" # 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: **operational**: *eq* (optional) + + # Retrieve all Managed Clusters. + + try { + Get-BetaManagedClusters + + # Below is a request that includes all optional parameters + # Get-BetaManagedClusters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for + $ClientLogConfiguration = @" + { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } + "@ + + # Update managed cluster's log configuration + + try { + Send-BetaClientLogConfiguration-BetaId $Id -BetaClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -BetaId $Id -BetaClientLogConfiguration $ClientLogConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -6838,162 +6994,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to get - $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get - - # Specified Managed Client Status. - - try { - Get-BetaManagedClientStatus-BetaId $Id -BetaType $Type - - # Below is a request that includes all optional parameters - # Get-BetaManagedClientStatus -BetaId $Id -BetaType $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to update - $ManagedClientStatus = @" - { - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - } - "@ - - # Handle status request from client - - try { - $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus - Update-BetaManagedClientStatus-BetaId $Id -BetaManagedClientStatus $Result - - # Below is a request that includes all optional parameters - # Update-BetaManagedClientStatus -BetaId $Id -BetaManagedClientStatus $ManagedClientStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for - - # Get managed cluster's log configuration - - try { - Get-BetaClientLogConfiguration-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaClientLogConfiguration -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster - source: | - $Id = "aClusterId" # String | ID of the ManagedCluster to get - - # Get a specified ManagedCluster. - - try { - Get-BetaManagedCluster-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaManagedCluster -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters - source: | - $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) - $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) - $Filters = "operational eq operation" # 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: **operational**: *eq* (optional) - - # Retrieve all Managed Clusters. - - try { - Get-BetaManagedClusters - - # Below is a request that includes all optional parameters - # Get-BetaManagedClusters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for - $ClientLogConfiguration = @" - { - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - } - "@ - - # Update managed cluster's log configuration - - try { - Send-BetaClientLogConfiguration-BetaId $Id -BetaClientLogConfiguration $Result - - # Below is a request that includes all optional parameters - # Send-BetaClientLogConfiguration -BetaId $Id -BetaClientLogConfiguration $ClientLogConfiguration - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } - path: /multihosts method: POST xCodeSample: @@ -9772,6 +9772,513 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" Write-Host $_.ErrorDetails } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig-BetaSearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-BetaSearchAttributeConfig-BetaName $Name + + # Below is a request that includes all optional parameters + # Remove-BetaSearchAttributeConfig -BetaName $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + + # List Extended Search Attributes + + try { + Get-BetaSearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-BetaSearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + + # Get Extended Search Attribute + + try { + Get-BetaSingleSearchAttributeConfig-BetaName $Name + + # Below is a request that includes all optional parameters + # Get-BetaSingleSearchAttributeConfig -BetaName $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig-BetaName $Name -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-BetaSegment-BetaSegment $Result + + # Below is a request that includes all optional parameters + # New-BetaSegment -BetaSegment $Segment + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-BetaSegment-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSegment -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-BetaSegment-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSegment -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments + source: | + $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) + $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 Segments + + try { + Get-BetaSegments + + # Below is a request that includes all optional parameters + # Get-BetaSegments -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSegment-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSegment -BetaId $Id -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-BetaServiceDeskIntegration-BetaServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-BetaServiceDeskIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaServiceDeskIntegration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-BetaServiceDeskIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + $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) + $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) + $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** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # 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* **type**: *eq, in* **cluster**: *eq, in* (optional) + $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 existing Service Desk integrations + + try { + Get-BetaServiceDeskIntegrationList + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-BetaServiceDeskIntegrationTemplate-BetaScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-BetaServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-BetaStatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-BetaStatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-BetaServiceDeskIntegration-BetaId $Id -BetaPatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration-BetaId $Id -BetaServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails-BetaQueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $QueuedCheckConfigDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } - path: /sim-integrations method: POST xCodeSample: @@ -10509,695 +11016,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" Write-Host $_.ErrorDetails } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-BetaSpConfig-BetaExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-BetaSpConfig -BetaExportPayload $ExportPayload - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-BetaSpConfigExport-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExport -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-BetaSpConfigExportStatus-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExportStatus -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-BetaSpConfigImport-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImport -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-BetaSpConfigImportStatus-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImportStatus -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-BetaSpConfig-BetaData $Data - - # Below is a request that includes all optional parameters - # Import-BetaSpConfig -BetaData $Data -BetaPreview $Preview -BetaOptions $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects - source: | - - # Get config object details - - try { - Get-BetaSpConfigObjects - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ - - # Create Extended Search Attributes - - try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-BetaSearchAttributeConfig-BetaSearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $SearchAttributeConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - - # Delete Extended Search Attribute - - try { - Remove-BetaSearchAttributeConfig-BetaName $Name - - # Below is a request that includes all optional parameters - # Remove-BetaSearchAttributeConfig -BetaName $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - - # List Extended Search Attributes - - try { - Get-BetaSearchAttributeConfig - - # Below is a request that includes all optional parameters - # Get-BetaSearchAttributeConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - - # Get Extended Search Attribute - - try { - Get-BetaSingleSearchAttributeConfig-BetaName $Name - - # Below is a request that includes all optional parameters - # Get-BetaSingleSearchAttributeConfig -BetaName $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSearchAttributeConfig-BetaName $Name -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $JsonPatchOperation - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-BetaSegment-BetaSegment $Result - - # Below is a request that includes all optional parameters - # New-BetaSegment -BetaSegment $Segment - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-BetaSegment-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSegment -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-BetaSegment-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSegment -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments - source: | - $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) - $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 Segments - - try { - Get-BetaSegments - - # Below is a request that includes all optional parameters - # Get-BetaSegments -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSegment-BetaId $Id -BetaRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaSegment -BetaId $Id -BetaRequestBody $RequestBody - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-BetaServiceDeskIntegration-BetaServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - $Id = "anId" # String | ID of Service Desk integration to delete - - # Delete a Service Desk integration - - try { - Remove-BetaServiceDeskIntegration-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaServiceDeskIntegration -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to get - - # Get a Service Desk integration - - try { - Get-BetaServiceDeskIntegration-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegration -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - $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) - $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) - $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** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # 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* **type**: *eq, in* **cluster**: *eq, in* (optional) - $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 existing Service Desk integrations - - try { - Get-BetaServiceDeskIntegrationList - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - - # Service Desk integration template by scriptName - - try { - Get-BetaServiceDeskIntegrationTemplate-BetaScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - - # List Service Desk integration types - - try { - Get-BetaServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details - source: | - - # Get the time check configuration - - try { - Get-BetaStatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-BetaStatusCheckDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration-BetaId $Id -BetaPatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Update a Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-BetaServiceDeskIntegration-BetaId $Id -BetaServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details - source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ - - # Update the time check configuration - - try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-BetaStatusCheckDetails-BetaQueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $QueuedCheckConfigDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-BetaStatusBySourceId-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaStatusBySourceId -BetaSourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $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) - $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) - $Sorters = "-date" # 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: **date** (optional) - - # Returns source usage insights - - try { - Get-BetaUsagesBySourceId-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesBySourceId -BetaSourceId $SourceId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" - Write-Host $_.ErrorDetails - } - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -12515,6 +12333,188 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" Write-Host $_.ErrorDetails } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-BetaStatusBySourceId-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaStatusBySourceId -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $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) + $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) + $Sorters = "-date" # 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: **date** (optional) + + # Returns source usage insights + + try { + Get-BetaUsagesBySourceId-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesBySourceId -BetaSourceId $SourceId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-BetaSpConfig-BetaExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-BetaSpConfig -BetaExportPayload $ExportPayload + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-BetaSpConfigExport-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExport -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-BetaSpConfigExportStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExportStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-BetaSpConfigImport-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImport -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-BetaSpConfigImportStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImportStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-BetaSpConfig-BetaData $Data + + # Below is a request that includes all optional parameters + # Import-BetaSpConfig -BetaData $Data -BetaPreview $Preview -BetaOptions $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects + source: | + + # Get config object details + + try { + Get-BetaSpConfigObjects + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -13700,6 +13700,416 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-BetaWorkflowExecution-BetaId $Id + + # Below is a request that includes all optional parameters + # Suspend-BetaWorkflowExecution -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-BetaWorkflow-BetaCreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkflow -BetaCreateWorkflowRequest $CreateWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-BetaWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkflow -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-BetaWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflow -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-BetaWorkflowExecution-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecution -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-BetaWorkflowExecutionHistory-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutionHistory -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $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) + $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) + $Filters = "status eq "Failed"" # 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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-BetaWorkflowExecutions-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutions -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library + source: | + $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) + + # List Complete Workflow Library + + try { + Get-BetaCompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-BetaCompleteWorkflowLibrary -BetaLimit $Limit -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions + source: | + $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 = "id eq "sp:create-campaign"" # 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* (optional) + + # List Workflow Library Actions + + try { + Get-BetaWorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryActions -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-BetaWorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers + source: | + $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 = "id eq "idn:identity-attributes-changed"" # 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* (optional) + + # List Workflow Library Triggers + + try { + Get-BetaWorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-BetaWorkflows + + # Below is a request that includes all optional parameters + # Get-BetaWorkflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaWorkflow-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $PostExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + Submit-BetaExternalExecuteWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Submit-BetaExternalExecuteWorkflow -BetaId $Id -BetaPostExternalExecuteWorkflowRequest $PostExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + Submit-BetaWorkflowExternalTrigger-BetaId $Id + + # Below is a request that includes all optional parameters + # Submit-BetaWorkflowExternalTrigger -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-BetaExternalExecuteWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Test-BetaExternalExecuteWorkflow -BetaId $Id -BetaTestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow-BetaId $Id -BetaTestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-BetaWorkflow -BetaId $Id -BetaTestWorkflowRequest $TestWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "description", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Update-BetaWorkflow-BetaId $Id -BetaWorkflowBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -BetaId $Id -BetaWorkflowBody $WorkflowBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -14165,413 +14575,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-BetaWorkflowExecution-BetaId $Id - - # Below is a request that includes all optional parameters - # Suspend-BetaWorkflowExecution -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-BetaWorkflow-BetaCreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaWorkflow -BetaCreateWorkflowRequest $CreateWorkflowRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-BetaWorkflow-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaWorkflow -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-BetaWorkflow-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflow -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-BetaWorkflowExecution-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecution -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-BetaWorkflowExecutionHistory-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutionHistory -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $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) - $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) - $Filters = "status eq "Failed"" # 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: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-BetaWorkflowExecutions-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutions -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library - source: | - $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) - - # List Complete Workflow Library - - try { - Get-BetaCompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-BetaCompleteWorkflowLibrary -BetaLimit $Limit -BetaOffset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions - source: | - $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 = "id eq "sp:create-campaign"" # 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* (optional) - - # List Workflow Library Actions - - try { - Get-BetaWorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryActions -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-BetaWorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers - source: | - $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 = "id eq "idn:identity-attributes-changed"" # 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* (optional) - - # List Workflow Library Triggers - - try { - Get-BetaWorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-BetaWorkflows - - # Below is a request that includes all optional parameters - # Get-BetaWorkflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaWorkflow-BetaId $Id -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $PostExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - Submit-BetaExternalExecuteWorkflow-BetaId $Id - - # Below is a request that includes all optional parameters - # Submit-BetaExternalExecuteWorkflow -BetaId $Id -BetaPostExternalExecuteWorkflowRequest $PostExternalExecuteWorkflowRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - Submit-BetaWorkflowExternalTrigger-BetaId $Id - - # Below is a request that includes all optional parameters - # Submit-BetaWorkflowExternalTrigger -BetaId $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-BetaExternalExecuteWorkflow-BetaId $Id - - # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -BetaId $Id -BetaTestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-BetaWorkflow-BetaId $Id -BetaTestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-BetaWorkflow -BetaId $Id -BetaTestWorkflowRequest $TestWorkflowRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "description", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow-BetaId $Id -BetaWorkflowBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -BetaId $Id -BetaWorkflowBody $WorkflowBody - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails - } diff --git a/static/code-examples/v2024/code_examples_overlay.yaml b/static/code-examples/v2024/code_examples_overlay.yaml index 21ca0a639..021bfeb63 100644 --- a/static/code-examples/v2024/code_examples_overlay.yaml +++ b/static/code-examples/v2024/code_examples_overlay.yaml @@ -478,7 +478,7 @@ $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) $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) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) $Sorters = "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: **created, modified** (optional) # Pending Access Request Approvals List @@ -909,29 +909,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $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) - $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) - $Sorters = "-date" # 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: **date** (optional) - - # Returns account usage insights - - try { - Get-V2024UsagesByAccountId-V2024AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2024UsagesByAccountId -V2024AccountId $AccountId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /accounts method: POST xCodeSample: @@ -1309,6 +1286,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $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) + $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) + $Sorters = "-date" # 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: **date** (optional) + + # Returns account usage insights + + try { + Get-V2024UsagesByAccountId-V2024AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesByAccountId -V2024AccountId $AccountId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /discovered-applications method: GET xCodeSample: @@ -2849,95 +2849,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $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) - $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) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.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: **access.name** (optional) - - # Access Summaries - - try { - Get-V2024IdentityAccessSummaries-V2024Id $Id -V2024Type $Type - - # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessSummaries -V2024Id $Id -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # 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: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2024IdentityDecisionSummary-V2024Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentityDecisionSummary -V2024Id $Id -V2024Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $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) - $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) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # 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* **completed**: *eq, ne* **name**: *eq, sw* (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** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2024IdentitySummaries-V2024Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummaries -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2024IdentitySummary-V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummary -V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3216,6 +3127,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $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) + $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) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.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: **access.name** (optional) + + # Access Summaries + + try { + Get-V2024IdentityAccessSummaries-V2024Id $Id -V2024Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessSummaries -V2024Id $Id -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # 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: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2024IdentityDecisionSummary-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -V2024Id $Id -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $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) + $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) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # 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* **completed**: *eq, ne* **name**: *eq, sw* (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** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2024IdentitySummaries-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummaries -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2024IdentitySummary-V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /configuration-hub/deploys method: POST xCodeSample: @@ -8219,164 +8219,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2024MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2024MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFAKbaConfig -V2024AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2024MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2024MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2024MFADuoConfig-V2024MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFADuoConfig -V2024MfaDuoConfig $MfaDuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2024MFAKBAConfig-V2024KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $KbaAnswerRequestItem - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2024MFAOktaConfig-V2024MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $MfaOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-V2024MFAConfig-V2024Method $Method - - # Below is a request that includes all optional parameters - # Test-V2024MFAConfig -V2024Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" - Write-Host $_.ErrorDetails - } - path: /managed-clients method: POST xCodeSample: @@ -8669,6 +8511,164 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" Write-Host $_.ErrorDetails } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-V2024MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2024MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAKbaConfig -V2024AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-V2024MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2024MFADuoConfig-V2024MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFADuoConfig -V2024MfaDuoConfig $MfaDuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2024MFAKBAConfig-V2024KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $KbaAnswerRequestItem + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2024MFAOktaConfig-V2024MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $MfaOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2024MFAConfig-V2024Method $Method + + # Below is a request that includes all optional parameters + # Test-V2024MFAConfig -V2024Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.ErrorDetails + } - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -11507,941 +11507,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" Write-Host $_.ErrorDetails } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2023-01-03T21:16:22.432Z", - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2024SIMIntegration-V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2024SIMIntegration -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a SIM integration - - try { - Remove-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a SIM integration details. - - try { - Get-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2024SIMIntegrations-V2024XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SIMIntegrations -V2024XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024BeforeProvisioningRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024BeforeProvisioningRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024SIMAttributes-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024SIMAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2023-01-03T21:16:22.432Z", - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2024SodPolicy-V2024SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2024SodPolicy -V2024SodPolicy $SodPolicy - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2024SodPolicy-V2024Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicy -V2024Id $Id -V2024Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2024SodPolicySchedule-V2024Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicySchedule -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2024CustomViolationReport-V2024ReportResultId $ReportResultId -V2024FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2024CustomViolationReport -V2024ReportResultId $ReportResultId -V2024FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2024DefaultViolationReport-V2024ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024DefaultViolationReport -V2024ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2024SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2024SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2024SodPolicy-V2024Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicy -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2024SodPolicySchedule-V2024Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicySchedule -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2024SodViolationReportRunStatus-V2024ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportRunStatus -V2024ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2024SodViolationReportStatus-V2024Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportStatus -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies - source: | - $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) - $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) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # 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* **state**: *eq, in* (optional) - $Sorters = "id,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: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-V2024SodPolicies - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SodPolicy-V2024Id $Id -V2024JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SodPolicy -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2024PolicySchedule-V2024Id $Id -V2024SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2024PolicySchedule -V2024Id $Id -V2024SodPolicySchedule $SodPolicySchedule - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2024SodPolicy-V2024Id $Id -V2024SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2024SodPolicy -V2024Id $Id -V2024SodPolicy $SodPolicy - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2024EvaluateSodPolicy-V2024Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024EvaluateSodPolicy -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2024SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $MultiPolicyRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2024SodPolicy-V2024Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024SodPolicy -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2024PredictSodViolations-V2024IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $IdentityWithNewAccess - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2024ViolationCheck-V2024IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $IdentityWithNewAccess1 - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $ExportPayload - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Download export job result. - - try { - Get-V2024SpConfigExport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get export job status - - try { - Get-V2024SpConfigExportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Download import job result - - try { - Get-V2024SpConfigImport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get import job status - - try { - Get-V2024SpConfigImportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data - - # Below is a request that includes all optional parameters - # Import-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data -V2024Preview $Preview -V2024Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get config object details - - try { - Get-V2024SpConfigObjects-V2024XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects -V2024XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" - Write-Host $_.ErrorDetails - } - path: /saved-searches method: POST xCodeSample: @@ -13798,46 +12863,792 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ - # Finds status of source usage + # Create new SIM integration try { - Get-V2024StatusBySourceId-V2024SourceId $SourceId + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration-V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Get-V2024StatusBySourceId -V2024SourceId $SourceId + # New-V2024SIMIntegration -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration + source: | + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a SIM integration + + try { + Remove-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a SIM integration details. + + try { + Get-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2024SIMIntegrations-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegrations -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024BeforeProvisioningRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024SIMAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2024SodPolicy-V2024SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2024SodPolicy -V2024SodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicy -V2024Id $Id -V2024Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2024SodPolicySchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicySchedule -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2024CustomViolationReport-V2024ReportResultId $ReportResultId -V2024FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2024CustomViolationReport -V2024ReportResultId $ReportResultId -V2024FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2024DefaultViolationReport-V2024ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultViolationReport -V2024ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2024SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2024SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2024SodPolicySchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicySchedule -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2024SodViolationReportRunStatus-V2024ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportRunStatus -V2024ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2024SodViolationReportStatus-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportStatus -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $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) $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) - $Sorters = "-date" # 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: **date** (optional) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # 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* **state**: *eq, in* (optional) + $Sorters = "id,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: **id, name, created, modified, description** (optional) - # Returns source usage insights + # List SOD policies try { - Get-V2024UsagesBySourceId-V2024SourceId $SourceId + Get-V2024SodPolicies # Below is a request that includes all optional parameters - # Get-V2024UsagesBySourceId -V2024SourceId $SourceId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + # Get-V2024SodPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SodPolicy-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SodPolicy -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule-V2024Id $Id -V2024SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2024PolicySchedule -V2024Id $Id -V2024SodPolicySchedule $SodPolicySchedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy-V2024Id $Id -V2024SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2024SodPolicy -V2024Id $Id -V2024SodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2024EvaluateSodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024EvaluateSodPolicy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2024SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $MultiPolicyRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024SodPolicy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024PredictSodViolations-V2024IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $IdentityWithNewAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2024ViolationCheck-V2024IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $IdentityWithNewAccess1 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -15301,6 +15112,195 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" Write-Host $_.ErrorDetails } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-V2024StatusBySourceId-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024StatusBySourceId -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $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) + $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) + $Sorters = "-date" # 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: **date** (optional) + + # Returns source usage insights + + try { + Get-V2024UsagesBySourceId-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesBySourceId -V2024SourceId $SourceId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $ExportPayload + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Download export job result. + + try { + Get-V2024SpConfigExport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get export job status + + try { + Get-V2024SpConfigExportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Download import job result + + try { + Get-V2024SpConfigImport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get import job status + + try { + Get-V2024SpConfigImportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data -V2024Preview $Preview -V2024Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get config object details + + try { + Get-V2024SpConfigObjects-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigObjects -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -16413,6 +16413,417 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2024WorkflowExecution-V2024Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024WorkflowExecution -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2024ExternalExecuteWorkflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # New-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow-V2024CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Workflow -V2024CreateWorkflowRequest $CreateWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2024WorkflowExternalTrigger-V2024Id $Id + + # Below is a request that includes all optional parameters + # New-V2024WorkflowExternalTrigger -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2024Workflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Workflow -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2024Workflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Workflow -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2024WorkflowExecution-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecution -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2024WorkflowExecutionHistory-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutionHistory -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $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) + $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) + $Filters = "status eq "Failed"" # 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2024WorkflowExecutions-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutions -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library + source: | + $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) + + # List Complete Workflow Library + + try { + Get-V2024CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2024CompleteWorkflowLibrary -V2024Limit $Limit -V2024Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions + source: | + $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 = "id eq "sp:create-campaign"" # 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* (optional) + + # List Workflow Library Actions + + try { + Get-V2024WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryActions -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2024WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers + source: | + $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 = "id eq "idn:identity-attributes-changed"" # 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* (optional) + + # List Workflow Library Triggers + + try { + Get-V2024WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryTriggers -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2024Workflows + + # Below is a request that includes all optional parameters + # Get-V2024Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Workflow -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow-V2024Id $Id -V2024WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2024Workflow -V2024Id $Id -V2024WorkflowBody $WorkflowBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2024ExternalExecuteWorkflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Test-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow-V2024Id $Id -V2024TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2024Workflow -V2024Id $Id -V2024TestWorkflowRequest $TestWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.ErrorDetails + } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -16886,414 +17297,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2024WorkflowExecution-V2024Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2024WorkflowExecution -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2024ExternalExecuteWorkflow-V2024Id $Id - - # Below is a request that includes all optional parameters - # New-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2024Workflow-V2024CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024Workflow -V2024CreateWorkflowRequest $CreateWorkflowRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2024WorkflowExternalTrigger-V2024Id $Id - - # Below is a request that includes all optional parameters - # New-V2024WorkflowExternalTrigger -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2024Workflow-V2024Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Workflow -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2024Workflow-V2024Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Workflow -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2024WorkflowExecution-V2024Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecution -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2024WorkflowExecutionHistory-V2024Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutionHistory -V2024Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $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) - $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) - $Filters = "status eq "Failed"" # 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: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2024WorkflowExecutions-V2024Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutions -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library - source: | - $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) - - # List Complete Workflow Library - - try { - Get-V2024CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2024CompleteWorkflowLibrary -V2024Limit $Limit -V2024Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions - source: | - $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 = "id eq "sp:create-campaign"" # 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* (optional) - - # List Workflow Library Actions - - try { - Get-V2024WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryActions -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2024WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers - source: | - $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 = "id eq "idn:identity-attributes-changed"" # 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* (optional) - - # List Workflow Library Triggers - - try { - Get-V2024WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryTriggers -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2024Workflows - - # Below is a request that includes all optional parameters - # Get-V2024Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Workflow-V2024Id $Id -V2024JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Workflow -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2024Workflow-V2024Id $Id -V2024WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2024Workflow -V2024Id $Id -V2024WorkflowBody $WorkflowBody - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2024ExternalExecuteWorkflow-V2024Id $Id - - # Below is a request that includes all optional parameters - # Test-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2024Workflow-V2024Id $Id -V2024TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2024Workflow -V2024Id $Id -V2024TestWorkflowRequest $TestWorkflowRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" - Write-Host $_.ErrorDetails - } diff --git a/static/code-examples/v3/code_examples_overlay.yaml b/static/code-examples/v3/code_examples_overlay.yaml index 0a6961987..ef2be3787 100644 --- a/static/code-examples/v3/code_examples_overlay.yaml +++ b/static/code-examples/v3/code_examples_overlay.yaml @@ -353,7 +353,7 @@ $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) $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) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # 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* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) $Sorters = "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: **created, modified** (optional) # Pending Access Request Approvals List @@ -636,29 +636,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $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) - $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) - $Sorters = "-date" # 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: **date** (optional) - - # Returns account usage insights - - try { - Get-UsagesByAccountId-AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /accounts method: POST xCodeSample: @@ -926,6 +903,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $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) + $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) + $Sorters = "-date" # 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: **date** (optional) + + # Returns account usage insights + + try { + Get-UsagesByAccountId-AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /discovered-applications method: GET xCodeSample: @@ -2013,95 +2013,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $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) - $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) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.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: **access.name** (optional) - - # Access Summaries - - try { - Get-IdentityAccessSummaries-Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # 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: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-IdentityDecisionSummary-Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $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) - $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) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # 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* **completed**: *eq, ne* **name**: *eq, sw* (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** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-IdentitySummaries-Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-IdentitySummary-Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2380,6 +2291,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $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) + $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) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # 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: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.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: **access.name** (optional) + + # Access Summaries + + try { + Get-IdentityAccessSummaries-Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # 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: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-IdentityDecisionSummary-Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $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) + $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) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # 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* **completed**: *eq, ne* **name**: *eq, sw* (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** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-IdentitySummaries-Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-IdentitySummary-Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -3560,6 +3560,298 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" Write-Host $_.ErrorDetails } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-ManagedClient-ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedClient -ManagedClientRequest $ManagedClientRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-ManagedClient-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-ManagedClient-Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-ManagedClientStatus-Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients + source: | + $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) + $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) + $Filters = "name eq "client 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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-ManagedClients + + # Below is a request that includes all optional parameters + # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedClient-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedClient -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-ManagedCluster-ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedCluster -ManagedClusterRequest $ManagedClusterRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-ManagedCluster-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-ClientLogConfiguration-Id $Id + + # Below is a request that includes all optional parameters + # Get-ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-ManagedCluster-Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters + source: | + $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) + $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) + $Filters = "operational eq "operation"" # 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: **operational**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-ManagedClusters + + # Below is a request that includes all optional parameters + # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-ClientLogConfiguration-Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $PutClientLogConfigurationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedCluster-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedCluster -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" + Write-Host $_.ErrorDetails + } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -3886,298 +4178,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-ManagedClient-ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedClient -ManagedClientRequest $ManagedClientRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-ManagedClient-Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-ManagedClient-Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-ManagedClientStatus-Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients - source: | - $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) - $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) - $Filters = "name eq "client 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* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-ManagedClients - - # Below is a request that includes all optional parameters - # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedClient-Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedClient -Id $Id -JsonPatchOperation $JsonPatchOperation - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-ManagedCluster-ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedCluster -ManagedClusterRequest $ManagedClusterRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-ManagedCluster-Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-ClientLogConfiguration-Id $Id - - # Below is a request that includes all optional parameters - # Get-ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-ManagedCluster-Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters - source: | - $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) - $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) - $Filters = "operational eq "operation"" # 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: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-ManagedClusters - - # Below is a request that includes all optional parameters - # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-ClientLogConfiguration-Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $PutClientLogConfigurationRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedCluster-Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedCluster -Id $Id -JsonPatchOperation $JsonPatchOperation - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" - Write-Host $_.ErrorDetails - } - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -6128,558 +6128,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" Write-Host $_.ErrorDetails } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-SodPolicy-SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-SodPolicy -SodPolicy $SodPolicy - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-SodPolicy-Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-SodPolicySchedule-Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-CustomViolationReport-ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-DefaultViolationReport-ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-SodPolicy-Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-SodPolicySchedule-Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-SodViolationReportRunStatus-ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-SodViolationReportStatus-Id $Id - - # Below is a request that includes all optional parameters - # Get-SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies - source: | - $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) - $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) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # 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* **state**: *eq, in* (optional) - $Sorters = "id,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: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-SodPolicies - - # Below is a request that includes all optional parameters - # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SodPolicy-Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-SodPolicy -Id $Id -JsonPatchOperation $JsonPatchOperation - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-PolicySchedule-Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-PolicySchedule -Id $Id -SodPolicySchedule $SodPolicySchedule - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-SodPolicy-Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-SodPolicy -Id $Id -SodPolicy $SodPolicy - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-EvaluateSodPolicy-Id $Id - - # Below is a request that includes all optional parameters - # Start-EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-SodAllPoliciesForOrg -MultiPolicyRequest $MultiPolicyRequest - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-SodPolicy-Id $Id - - # Below is a request that includes all optional parameters - # Start-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-PredictSodViolations-IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-PredictSodViolations -IdentityWithNewAccess $IdentityWithNewAccess - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-ViolationCheck-IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-ViolationCheck -IdentityWithNewAccess1 $IdentityWithNewAccess1 - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" - Write-Host $_.ErrorDetails - } - path: /saved-searches method: POST xCodeSample: @@ -7988,46 +7436,556 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sod-policies + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ - # Finds status of source usage + # Create SOD policy try { - Get-StatusBySourceId-SourceId $SourceId + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy-SodPolicy $Result # Below is a request that includes all optional parameters - # Get-StatusBySourceId -SourceId $SourceId + # New-SodPolicy -SodPolicy $SodPolicy } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-SodPolicySchedule-Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-CustomViolationReport-ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-DefaultViolationReport-ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-SodPolicySchedule-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-SodViolationReportRunStatus-ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-SodViolationReportStatus-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $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) $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) - $Sorters = "-date" # 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: **date** (optional) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # 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* **state**: *eq, in* (optional) + $Sorters = "id,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: **id, name, created, modified, description** (optional) - # Returns source usage insights + # List SOD policies try { - Get-UsagesBySourceId-SourceId $SourceId + Get-SodPolicies # Below is a request that includes all optional parameters - # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SodPolicy -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule-Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-PolicySchedule -Id $Id -SodPolicySchedule $SodPolicySchedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-SodPolicy-Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-SodPolicy -Id $Id -SodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-EvaluateSodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Start-EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $MultiPolicyRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Start-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-PredictSodViolations-IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-PredictSodViolations -IdentityWithNewAccess $IdentityWithNewAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-ViolationCheck-IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-ViolationCheck -IdentityWithNewAccess1 $IdentityWithNewAccess1 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -8940,6 +8898,48 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" Write-Host $_.ErrorDetails } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-StatusBySourceId-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $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) + $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) + $Sorters = "-date" # 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: **date** (optional) + + # Returns source usage insights + + try { + Get-UsagesBySourceId-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + Write-Host $_.ErrorDetails + } - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -9403,271 +9403,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/approve/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Approve an Approval Item - - try { - Approve-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-approve/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk approve Approval Items - - try { - Approve-ApprovalItemsInBulk-Id $Id - - # Below is a request that includes all optional parameters - # Approve-ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Complete a Work Item - - try { - Complete-WorkItem-Id $Id - - # Below is a request that includes all optional parameters - # Complete-WorkItem -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) - $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) - $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) - - # Completed Work Items - - try { - Get-CompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/completed/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Count Completed Work Items - - try { - Get-CountCompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-CountCompletedWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/count - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items - source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - - # Count Work Items - - try { - Get-CountWorkItems - - # Below is a request that includes all optional parameters - # Get-CountWorkItems -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item - source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - - # Get a Work Item - - try { - Get-WorkItem-Id $Id - - # Below is a request that includes all optional parameters - # Get-WorkItem -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary - source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # Work Items Summary - - try { - Get-WorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-WorkItemsSummary -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" - Write-Host $_.ErrorDetails - } -- path: /work-items - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items - source: | - $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) - $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) - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - - # List Work Items - - try { - Get-WorkItems - - # Below is a request that includes all optional parameters - # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - - # Reject an Approval Item - - try { - Deny-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" - Write-Host $_.ErrorDetails - } -- path: /work-items/bulk-reject/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - - # Bulk reject Approval Items - - try { - Deny-ApprovalItemsInBulk-Id $Id - - # Below is a request that includes all optional parameters - # Deny-ApprovalItemsInBulk -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ - - # Forward a Work Item - - try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-WorkItemForward-Id $Id -WorkItemForward $Result - - # Below is a request that includes all optional parameters - # Send-WorkItemForward -Id $Id -WorkItemForward $WorkItemForward - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" - Write-Host $_.ErrorDetails - } -- path: /work-items/{id}/submit-account-selection - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - - # Submit Account Selections - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-AccountSelection-Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-AccountSelection -Id $Id -RequestBody $RequestBody - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" - Write-Host $_.ErrorDetails - } - path: /workflow-executions/{id}/cancel method: POST xCodeSample: @@ -10079,3 +9814,268 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" Write-Host $_.ErrorDetails } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-ApprovalItemsInBulk-Id $Id + + # Below is a request that includes all optional parameters + # Approve-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Complete a Work Item + + try { + Complete-WorkItem-Id $Id + + # Below is a request that includes all optional parameters + # Complete-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $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) + $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) + + # Completed Work Items + + try { + Get-CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CountCompletedWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-CountWorkItems + + # Below is a request that includes all optional parameters + # Get-CountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-WorkItem-Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-WorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items + source: | + $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) + $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) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-WorkItems + + # Below is a request that includes all optional parameters + # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-ApprovalItemsInBulk-Id $Id + + # Below is a request that includes all optional parameters + # Deny-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-WorkItemForward-Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-WorkItemForward -Id $Id -WorkItemForward $WorkItemForward + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-AccountSelection-Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-AccountSelection -Id $Id -RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" + Write-Host $_.ErrorDetails + }