From 72c854f333f504d089b358c953ea0911bc67dc99 Mon Sep 17 00:00:00 2001 From: developer-relations-sp Date: Fri, 28 Feb 2025 14:46:13 +0000 Subject: [PATCH] Update to powershell SDK docs: 13590494573 --- .../Beta/Methods/BetaAccessProfilesApi.md | 16 +- .../Methods/BetaAccessRequestApprovalsApi.md | 12 +- .../Beta/Methods/BetaAccessRequestsApi.md | 16 +- .../Reference/Beta/Methods/BetaAccountsApi.md | 36 +- .../Methods/BetaApplicationDiscoveryApi.md | 2 +- .../Reference/Beta/Methods/BetaAppsApi.md | 10 +- .../Beta/Methods/BetaAuthProfileApi.md | 4 +- .../Methods/BetaCertificationCampaignsApi.md | 30 +- .../Beta/Methods/BetaCertificationsApi.md | 4 +- .../Methods/BetaConnectorRuleManagementApi.md | 10 +- .../Beta/Methods/BetaCustomFormsApi.md | 12 +- .../BetaCustomPasswordInstructionsApi.md | 4 +- .../Beta/Methods/BetaEntitlementsApi.md | 10 +- .../Beta/Methods/BetaGovernanceGroupsApi.md | 18 +- .../BetaIAIAccessRequestRecommendationsApi.md | 16 +- .../Beta/Methods/BetaIAICommonAccessApi.md | 8 +- .../Beta/Methods/BetaIAIRecommendationsApi.md | 8 +- .../Beta/Methods/BetaIAIRoleMiningApi.md | 24 +- .../Beta/Methods/BetaIdentitiesApi.md | 12 +- .../Beta/Methods/BetaIdentityAttributesApi.md | 12 +- .../Beta/Methods/BetaIdentityProfilesApi.md | 85 +- .../Beta/Methods/BetaLaunchersApi.md | 8 +- .../Beta/Methods/BetaLifecycleStatesApi.md | 4 +- .../Beta/Methods/BetaMFAConfigurationApi.md | 12 +- .../Beta/Methods/BetaMFAControllerApi.md | 24 +- .../Beta/Methods/BetaManagedClientsApi.md | 4 +- .../Beta/Methods/BetaManagedClustersApi.md | 4 +- .../Methods/BetaMultiHostIntegrationApi.md | 12 +- .../BetaNonEmployeeLifecycleManagementApi.md | 66 +- .../Beta/Methods/BetaNotificationsApi.md | 24 +- .../Beta/Methods/BetaOAuthClientsApi.md | 8 +- .../Beta/Methods/BetaOrgConfigApi.md | 4 +- .../Methods/BetaPasswordConfigurationApi.md | 8 +- .../Beta/Methods/BetaPasswordManagementApi.md | 12 +- .../Beta/Methods/BetaPasswordPoliciesApi.md | 8 +- .../Beta/Methods/BetaPasswordSyncGroupsApi.md | 8 +- .../Methods/BetaPersonalAccessTokensApi.md | 8 +- .../Methods/BetaPublicIdentitiesConfigApi.md | 4 +- .../Reference/Beta/Methods/BetaRolesApi.md | 12 +- .../Beta/Methods/BetaSIMIntegrationsApi.md | 16 +- .../Beta/Methods/BetaSODPoliciesApi.md | 14 +- .../Beta/Methods/BetaSODViolationsApi.md | 4 +- .../Reference/Beta/Methods/BetaSPConfigApi.md | 6 +- .../BetaSearchAttributeConfigurationApi.md | 8 +- .../Reference/Beta/Methods/BetaSegmentsApi.md | 4 +- .../Methods/BetaServiceDeskIntegrationApi.md | 16 +- .../Reference/Beta/Methods/BetaSourcesApi.md | 60 +- .../BetaSuggestedEntitlementDescriptionApi.md | 14 +- .../Beta/Methods/BetaTaggedObjectsApi.md | 16 +- .../Reference/Beta/Methods/BetaTagsApi.md | 4 +- .../Beta/Methods/BetaTaskManagementApi.md | 4 +- .../Beta/Methods/BetaTransformsApi.md | 6 +- .../Reference/Beta/Methods/BetaTriggersApi.md | 24 +- .../Beta/Methods/BetaUIMetadataApi.md | 4 +- .../Methods/BetaVendorConnectorMappingsApi.md | 8 +- .../Beta/Methods/BetaWorkItemsApi.md | 4 +- .../Beta/Methods/BetaWorkReassignmentApi.md | 12 +- .../Beta/Methods/BetaWorkflowsApi.md | 20 +- .../Reference/Beta/Models/AccessCriteria.md | 2 +- .../Beta/Models/AccessProfileUpdateItem.md | 4 +- .../Reference/Beta/Models/AccessRequest.md | 2 +- .../Beta/Models/AccessRequestItem.md | 2 +- .../Beta/Models/AccessRequestItemResponse.md | 2 +- ...stPostApprovalRequestedItemsStatusInner.md | 2 +- .../AccessRequestRecommendationItemDetail.md | 2 +- .../Beta/Models/AccessRequestResponse.md | 4 +- .../Beta/Models/AccessRequestResponse1.md | 2 +- .../Beta/Models/AccessRequestTracking.md | 4 +- .../Reference/Beta/Models/Account.md | 2 +- .../Beta/Models/AccountActivityItem.md | 2 +- .../Reference/Beta/Models/AccountAttribute.md | 6 +- .../Beta/Models/AccountAttributes.md | 2 +- .../Models/AccountAttributesChangedAccount.md | 2 +- .../Beta/Models/AccountCorrelated.md | 2 +- .../Beta/Models/AccountCorrelatedAccount.md | 2 +- .../Reference/Beta/Models/AccountInfoDto.md | 2 +- .../Beta/Models/AccountUncorrelatedAccount.md | 2 +- .../Reference/Beta/Models/AccountUsage.md | 2 +- .../Models/AppAccountDetailsSourceAccount.md | 2 +- .../Reference/Beta/Models/Approval.md | 6 +- .../Beta/Models/AttrSyncSourceConfig.md | 2 +- .../Reference/Beta/Models/AttributeDTOList.md | 2 +- .../Reference/Beta/Models/Base64Decode.md | 2 +- .../Reference/Beta/Models/Base64Encode.md | 2 +- .../Models/BulkIdentitiesAccountsResponse.md | 2 +- .../Beta/Models/CompleteInvocation.md | 2 +- .../Beta/Models/CompleteInvocationInput.md | 2 +- .../Beta/Models/CompletedApproval.md | 2 +- .../Reference/Beta/Models/Concatenation.md | 2 +- .../Reference/Beta/Models/Conditional.md | 2 +- .../Reference/Beta/Models/ConnectorDetail.md | 8 +- .../Beta/Models/CorrelatedGovernanceEvent.md | 4 +- ...relationConfigAttributeAssignmentsInner.md | 2 +- .../Beta/Models/CreateFormInstanceRequest.md | 2 +- .../Beta/Models/CreateWorkflowRequest.md | 2 +- .../Reference/Beta/Models/DateCompare.md | 2 +- .../Beta/Models/DateCompareFirstDate.md | 6 +- .../Beta/Models/DateCompareSecondDate.md | 6 +- .../Reference/Beta/Models/DateFormat.md | 2 +- .../Reference/Beta/Models/DateMath.md | 2 +- .../Beta/Models/DecomposeDiacriticalMarks.md | 2 +- .../Reference/Beta/Models/E164phone.md | 2 +- .../Reference/Beta/Models/Entitlement.md | 6 +- .../Models/EntitlementAccessModelMetadata.md | 2 +- .../Models/EntitlementBulkUpdateRequest.md | 2 +- .../Reference/Beta/Models/EntitlementRef.md | 2 +- .../Reference/Beta/Models/EventAttributes.md | 2 +- .../Beta/Models/ExceptionCriteria.md | 2 +- .../Beta/Models/ExceptionCriteriaAccess.md | 2 +- .../ExceptionCriteriaCriteriaListInner.md | 2 +- .../Reference/Beta/Models/ExportOptions.md | 2 +- .../Reference/Beta/Models/ExportPayload.md | 2 +- .../powershell/Reference/Beta/Models/Field.md | 2 +- .../Reference/Beta/Models/FieldDetails.md | 2 +- .../Reference/Beta/Models/FieldDetailsDto.md | 4 +- .../Reference/Beta/Models/FirstValid.md | 2 +- .../FormDefinitionDynamicSchemaResponse.md | 2 +- .../Reference/Beta/Models/FormElement.md | 2 +- .../Beta/Models/FormInstanceResponse.md | 4 +- ...istoricalIdentityEvents200ResponseInner.md | 4 +- .../GetRoleAssignments200ResponseInner.md | 4 +- .../Reference/Beta/Models/ISO3166.md | 2 +- .../Reference/Beta/Models/Identity.md | 2 +- ...sociationDetailsAssociationDetailsInner.md | 2 +- .../Beta/Models/IdentityAttribute1.md | 2 +- .../Beta/Models/IdentityAttributeConfig.md | 2 +- .../Beta/Models/IdentityAttributeConfig1.md | 2 +- .../Beta/Models/IdentityAttributeTransform.md | 2 +- .../Models/IdentityAttributeTransform1.md | 2 +- .../Beta/Models/IdentityCertified.md | 4 +- .../Reference/Beta/Models/IdentityCreated.md | 2 +- .../Reference/Beta/Models/IdentityDeleted.md | 2 +- .../IdentityExceptionReportReference.md | 4 +- .../IdentityExceptionReportReference1.md | 4 +- .../Beta/Models/IdentityHistoryResponse.md | 4 +- ...sociationDetailsAssociationDetailsInner.md | 2 +- .../Reference/Beta/Models/IdentityProfile.md | 10 +- .../Reference/Beta/Models/IdentityProfile1.md | 10 +- ...dentityProfile1AllOfAuthoritativeSource.md | 6 +- ...IdentityProfileAllOfAuthoritativeSource.md | 6 +- .../Beta/Models/IdentityProfileAllOfOwner.md | 6 +- .../Beta/Models/IdentitySyncPayload.md | 2 +- .../Beta/Models/IdentityWithNewAccess.md | 2 +- .../IdentityWithNewAccessAccessRefsInner.md | 2 +- .../Reference/Beta/Models/ImportOptions.md | 2 +- .../Reference/Beta/Models/IndexOf.md | 2 +- .../Reference/Beta/Models/Invocation.md | 2 +- .../Beta/Models/KbaAnswerResponseItem.md | 2 +- .../Reference/Beta/Models/KbaAuthResponse.md | 2 +- .../Reference/Beta/Models/KbaQuestion.md | 2 +- .../Reference/Beta/Models/Launcher.md | 2 +- .../Reference/Beta/Models/LauncherRequest.md | 2 +- .../Reference/Beta/Models/LeftPad.md | 2 +- ...CompleteWorkflowLibrary200ResponseInner.md | 4 +- .../ListFormElementDataByElementIDResponse.md | 2 +- .../Beta/Models/LoadEntitlementTask.md | 2 +- .../LoadUncorrelatedAccountsTaskTask.md | 2 +- .../Reference/Beta/Models/Lookup.md | 4 +- .../powershell/Reference/Beta/Models/Lower.md | 2 +- .../Beta/Models/MailFromAttributes.md | 2 +- .../Beta/Models/ManagedClientStatus.md | 2 +- .../Models/ManagedClientStatusAggResponse.md | 2 +- .../Reference/Beta/Models/ManagedCluster.md | 2 +- .../Beta/Models/ManualDiscoverApplications.md | 4 +- .../Reference/Beta/Models/MatchTerm.md | 2 +- .../Reference/Beta/Models/MfaDuoConfig.md | 2 +- .../Models/MultiHostIntegrationsCreate.md | 2 +- .../MultiHostIntegrationsCreateSources.md | 2 +- .../Reference/Beta/Models/MultiHostSources.md | 6 +- .../Reference/Beta/Models/NameNormalizer.md | 2 +- .../Beta/Models/NonEmployeeRecord.md | 2 +- .../Beta/Models/NonEmployeeRequest.md | 2 +- .../Beta/Models/NonEmployeeRequestBody.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 6 +- .../Models/NonEmployeeSourceWithNECount.md | 2 +- .../Models/NotificationTemplateContext.md | 2 +- .../Reference/Beta/Models/OrgConfig.md | 4 +- .../Reference/Beta/Models/Outlier.md | 2 +- .../Beta/Models/OutlierFeatureSummary.md | 2 +- .../Beta/Models/PasswordChangeRequest.md | 4 +- .../Beta/Models/PasswordInfoAccount.md | 2 +- .../PostExternalExecuteWorkflowRequest.md | 2 +- .../Beta/Models/PreviewDataSourceResponse.md | 2 +- .../Reference/Beta/Models/Product.md | 2 +- ...ovisioningCompletedAccountRequestsInner.md | 2 +- ...ountRequestsInnerAttributeRequestsInner.md | 2 +- .../Beta/Models/ProvisioningConfig.md | 2 +- ...ProvisioningConfigPlanInitializerScript.md | 2 +- .../Beta/Models/RandomAlphaNumeric.md | 2 +- .../Reference/Beta/Models/RandomNumeric.md | 2 +- .../Beta/Models/RecommendationResponse.md | 2 +- .../Reference/Beta/Models/Reference.md | 2 +- .../Reference/Beta/Models/Replace.md | 2 +- .../Reference/Beta/Models/ReplaceAll.md | 4 +- .../Beta/Models/RequestedItemStatus.md | 2 +- .../Beta/Models/ResourceBundleMessage.md | 2 +- .../Reference/Beta/Models/ResourceObject.md | 4 +- .../Reference/Beta/Models/RightPad.md | 2 +- .../powershell/Reference/Beta/Models/Role.md | 2 +- .../Beta/Models/RoleAssignmentDto.md | 4 +- .../Models/RoleMiningIdentityDistribution.md | 2 +- .../RoleMiningPotentialRoleApplication.md | 4 +- .../RoleMiningPotentialRoleEntitlements.md | 4 +- .../Beta/Models/RoleMiningSessionScope.md | 2 +- .../Beta/Models/SavedSearchComplete.md | 2 +- .../Reference/Beta/Models/Schedule1Days.md | 2 +- .../Reference/Beta/Models/Schedule1Hours.md | 2 +- .../Reference/Beta/Models/Schedule1Months.md | 2 +- .../Reference/Beta/Models/Schema.md | 4 +- .../Beta/Models/SearchAttributeConfig.md | 2 +- .../Reference/Beta/Models/Selector.md | 2 +- ...lectorAccountMatchConfigMatchExpression.md | 2 +- .../Beta/Models/ServiceDeskIntegrationDto.md | 2 +- .../Beta/Models/SimIntegrationDetails.md | 6 +- .../Reference/Beta/Models/SodPolicy.md | 2 +- .../Beta/Models/SodViolationCheckResult.md | 2 +- .../Beta/Models/SodViolationCheckResult1.md | 2 +- .../Reference/Beta/Models/Source.md | 6 +- .../Reference/Beta/Models/Source1.md | 2 +- .../Beta/Models/SourceAccountCreated.md | 2 +- .../Beta/Models/SourceAccountDeleted.md | 2 +- .../Beta/Models/SourceAccountUpdated.md | 2 +- .../Beta/Models/SourceAppAccountSource.md | 2 +- .../Beta/Models/SourceAppBulkUpdateRequest.md | 2 +- .../Reference/Beta/Models/SourceCode.md | 2 +- .../Beta/Models/SourceCreationErrors.md | 2 +- .../Beta/Models/SourceSyncPayload.md | 2 +- .../Reference/Beta/Models/SourceUsage.md | 2 +- .../Beta/Models/SpConfigImportResults.md | 2 +- .../Reference/Beta/Models/SpConfigMessage.md | 2 +- .../Reference/Beta/Models/SpConfigObject.md | 2 - .../Reference/Beta/Models/SpConfigRule.md | 6 +- .../Beta/Models/SpConfigRuleValue.md | 34 - .../powershell/Reference/Beta/Models/Split.md | 2 +- .../Beta/Models/StartInvocationInput.md | 4 +- .../Reference/Beta/Models/StatusResponse.md | 2 +- .../Reference/Beta/Models/Subscription.md | 2 +- .../Beta/Models/SubscriptionPostRequest.md | 2 +- .../Beta/Models/SubscriptionPutRequest.md | 2 +- .../Reference/Beta/Models/Substring.md | 2 +- .../Beta/Models/TagTagCategoryRefsInner.md | 2 +- .../Reference/Beta/Models/TaskStatus.md | 2 +- .../Beta/Models/TaskStatusMessage.md | 2 +- .../Reference/Beta/Models/TemplateDto.md | 2 +- .../Beta/Models/TemplateDtoDefault.md | 2 +- .../TestExternalExecuteWorkflow200Response.md | 2 +- .../TestExternalExecuteWorkflowRequest.md | 2 +- .../Reference/Beta/Models/TestInvocation.md | 4 +- .../Beta/Models/TransformAttributes.md | 8 +- .../Beta/Models/TransformDefinition.md | 4 +- .../Beta/Models/TransformDefinition1.md | 4 +- .../Reference/Beta/Models/Trigger.md | 4 +- .../Beta/Models/TriggerExampleInput.md | 4 +- .../powershell/Reference/Beta/Models/Trim.md | 2 +- .../powershell/Reference/Beta/Models/Upper.md | 2 +- .../Reference/Beta/Models/V3ConnectorDto.md | 2 +- .../Beta/Models/ValidateFilterInputDto.md | 4 +- .../Reference/Beta/Models/WorkItemForward.md | 2 +- .../Reference/Beta/Models/WorkItems.md | 2 +- .../Reference/Beta/Models/Workflow.md | 2 +- .../Reference/Beta/Models/WorkflowBody.md | 2 +- .../Beta/Models/WorkflowDefinition.md | 2 +- .../Beta/Models/WorkflowExecution.md | 2 +- .../Beta/Models/WorkflowLibraryAction.md | 2 +- .../Beta/Models/WorkflowLibraryOperator.md | 2 +- .../Beta/Models/WorkflowLibraryTrigger.md | 2 +- .../Beta/Models/WorkflowTriggerAttributes.md | 2 +- .../Beta/Models/WorkgroupDeleteItem.md | 6 +- .../Beta/Models/WorkgroupMemberAddItem.md | 4 +- .../Beta/Models/WorkgroupMemberDeleteItem.md | 4 +- .../V2024/Methods/V2024AccessProfilesApi.md | 16 +- .../Methods/V2024AccessRequestApprovalsApi.md | 10 +- .../V2024AccessRequestIdentityMetricsApi.md | 9 +- .../V2024/Methods/V2024AccessRequestsApi.md | 24 +- .../V2024/Methods/V2024AccountsApi.md | 36 +- .../Reference/V2024/Methods/V2024AppsApi.md | 10 +- .../V2024/Methods/V2024AuthProfileApi.md | 4 +- .../V2024/Methods/V2024AuthUsersApi.md | 4 +- .../V2024CertificationCampaignFiltersApi.md | 8 +- .../Methods/V2024CertificationCampaignsApi.md | 34 +- .../V2024/Methods/V2024CertificationsApi.md | 12 +- .../V2024/Methods/V2024ConfigurationHubApi.md | 16 +- .../V2024ConnectorRuleManagementApi.md | 10 +- .../V2024/Methods/V2024ConnectorsApi.md | 8 +- .../V2024/Methods/V2024CustomFormsApi.md | 10 +- .../V2024CustomPasswordInstructionsApi.md | 4 +- .../V2024/Methods/V2024DataSegmentationApi.md | 4 +- .../V2024/Methods/V2024DimensionsApi.md | 12 +- .../V2024/Methods/V2024EntitlementsApi.md | 10 +- .../V2024GlobalTenantSecuritySettingsApi.md | 8 +- .../V2024/Methods/V2024GovernanceGroupsApi.md | 18 +- ...V2024IAIAccessRequestRecommendationsApi.md | 124 +- .../V2024/Methods/V2024IAICommonAccessApi.md | 8 +- .../Methods/V2024IAIRecommendationsApi.md | 8 +- .../V2024/Methods/V2024IAIRoleMiningApi.md | 24 +- .../V2024/Methods/V2024IdentitiesApi.md | 12 +- .../Methods/V2024IdentityAttributesApi.md | 12 +- .../V2024/Methods/V2024IdentityProfilesApi.md | 84 +- .../V2024/Methods/V2024LifecycleStatesApi.md | 12 +- .../V2024/Methods/V2024MFAConfigurationApi.md | 12 +- .../V2024/Methods/V2024MachineAccountsApi.md | 190 - .../Methods/V2024MachineIdentitiesApi.md | 298 - .../V2024/Methods/V2024ManagedClientsApi.md | 8 +- .../V2024/Methods/V2024ManagedClustersApi.md | 12 +- .../V2024NonEmployeeLifecycleManagementApi.md | 66 +- .../V2024/Methods/V2024NotificationsApi.md | 24 +- .../V2024/Methods/V2024OAuthClientsApi.md | 8 +- .../V2024/Methods/V2024OrgConfigApi.md | 4 +- .../Methods/V2024PasswordConfigurationApi.md | 8 +- .../Methods/V2024PasswordManagementApi.md | 12 +- .../V2024/Methods/V2024PasswordPoliciesApi.md | 8 +- .../Methods/V2024PasswordSyncGroupsApi.md | 8 +- .../Methods/V2024PersonalAccessTokensApi.md | 8 +- .../Methods/V2024PublicIdentitiesConfigApi.md | 4 +- .../Methods/V2024ReportsDataExtractionApi.md | 4 +- .../Reference/V2024/Methods/V2024RolesApi.md | 26 +- .../V2024/Methods/V2024SIMIntegrationsApi.md | 16 +- .../V2024/Methods/V2024SODPoliciesApi.md | 18 +- .../V2024/Methods/V2024SODViolationsApi.md | 8 +- .../V2024/Methods/V2024SPConfigApi.md | 63 +- .../V2024/Methods/V2024SavedSearchApi.md | 12 +- .../V2024/Methods/V2024ScheduledSearchApi.md | 12 +- .../Reference/V2024/Methods/V2024SearchApi.md | 12 +- .../V2024SearchAttributeConfigurationApi.md | 8 +- .../V2024/Methods/V2024SegmentsApi.md | 4 +- .../Methods/V2024ServiceDeskIntegrationApi.md | 16 +- .../V2024/Methods/V2024SourcesApi.md | 72 +- ...V2024SuggestedEntitlementDescriptionApi.md | 80 +- .../V2024/Methods/V2024TaggedObjectsApi.md | 16 +- .../V2024/Methods/V2024TaskManagementApi.md | 4 +- .../Reference/V2024/Methods/V2024TenantApi.md | 9 +- .../V2024/Methods/V2024TransformsApi.md | 6 +- .../V2024/Methods/V2024TriggersApi.md | 24 +- .../V2024/Methods/V2024UIMetadataApi.md | 4 +- .../V2024VendorConnectorMappingsApi.md | 8 +- .../V2024/Methods/V2024WorkItemsApi.md | 4 +- .../V2024/Methods/V2024WorkReassignmentApi.md | 12 +- .../V2024/Methods/V2024WorkflowsApi.md | 20 +- .../Reference/V2024/Models/AccessCriteria.md | 2 +- .../V2024/Models/AccessProfileEntitlement.md | 2 +- .../V2024/Models/AccessProfileUpdateItem.md | 4 +- .../Reference/V2024/Models/AccessRequest.md | 2 +- .../Models/AccessRequestAdminItemStatus.md | 2 +- .../V2024/Models/AccessRequestItem.md | 2 +- .../V2024/Models/AccessRequestItemResponse.md | 2 +- ...stPostApprovalRequestedItemsStatusInner.md | 2 +- .../AccessRequestRecommendationConfigDto.md | 45 - .../AccessRequestRecommendationItemDetail.md | 2 +- .../V2024/Models/AccessRequestResponse.md | 4 +- .../V2024/Models/AccessRequestResponse1.md | 2 +- .../V2024/Models/AccessRequestTracking.md | 4 +- .../Reference/V2024/Models/Account.md | 2 +- .../Reference/V2024/Models/AccountActivity.md | 2 +- .../V2024/Models/AccountActivityItem.md | 2 +- .../V2024/Models/AccountAttribute.md | 6 +- .../V2024/Models/AccountAttributes.md | 2 +- .../Models/AccountAttributesChangedAccount.md | 2 +- .../V2024/Models/AccountCorrelated.md | 2 +- .../V2024/Models/AccountCorrelatedAccount.md | 2 +- .../Reference/V2024/Models/AccountInfoDto.md | 2 +- .../Models/AccountUncorrelatedAccount.md | 2 +- .../Reference/V2024/Models/AccountUsage.md | 2 +- .../V2024/Models/AggregationResult.md | 2 +- .../Models/AppAccountDetailsSourceAccount.md | 2 +- .../Reference/V2024/Models/AppAllOfAccount.md | 2 +- .../Reference/V2024/Models/Approval.md | 6 +- .../V2024/Models/AttrSyncSourceConfig.md | 2 +- .../V2024/Models/AttributeDTOList.md | 2 +- .../Reference/V2024/Models/BackupOptions.md | 2 +- .../Reference/V2024/Models/Base64Decode.md | 2 +- .../Reference/V2024/Models/Base64Encode.md | 2 +- .../Reference/V2024/Models/BaseAccount.md | 4 +- .../Reference/V2024/Models/BaseEntitlement.md | 4 +- .../Models/BulkIdentitiesAccountsResponse.md | 2 +- .../V2024/Models/CampaignFilterDetails.md | 4 +- .../V2024/Models/CertificationTask.md | 2 +- .../V2024/Models/CompleteInvocation.md | 2 +- .../V2024/Models/CompleteInvocationInput.md | 2 +- .../V2024/Models/CompletedApproval.md | 2 +- .../Reference/V2024/Models/Concatenation.md | 2 +- .../Reference/V2024/Models/Conditional.md | 2 +- .../Reference/V2024/Models/ConnectorDetail.md | 94 +- .../V2024/Models/ConnectorDetail1.md | 8 +- .../V2024/Models/CorrelatedGovernanceEvent.md | 4 +- ...relationConfigAttributeAssignmentsInner.md | 2 +- .../CreateExternalExecuteWorkflowRequest.md | 2 +- .../V2024/Models/CreateFormInstanceRequest.md | 2 +- .../V2024/Models/CreateSavedSearchRequest.md | 4 +- .../V2024/Models/CreateWorkflowRequest.md | 2 +- .../Reference/V2024/Models/DataSegment.md | 4 +- .../Reference/V2024/Models/DateCompare.md | 2 +- .../V2024/Models/DateCompareFirstDate.md | 6 +- .../V2024/Models/DateCompareSecondDate.md | 6 +- .../Reference/V2024/Models/DateFormat.md | 2 +- .../Reference/V2024/Models/DateMath.md | 2 +- .../V2024/Models/DecomposeDiacriticalMarks.md | 2 +- .../Reference/V2024/Models/E164phone.md | 2 +- .../Reference/V2024/Models/Entitlement.md | 6 +- .../Reference/V2024/Models/Entitlement1.md | 6 +- .../Models/Entitlement1AccessModelMetadata.md | 2 +- .../Models/EntitlementBulkUpdateRequest.md | 2 +- .../Reference/V2024/Models/EntitlementDto.md | 4 +- .../Reference/V2024/Models/EntitlementRef.md | 2 +- .../Reference/V2024/Models/EntitlementRef1.md | 2 +- .../V2024/Models/EntitlementSummary.md | 2 +- .../Reference/V2024/Models/Event.md | 2 +- .../Reference/V2024/Models/EventAttributes.md | 4 +- .../Reference/V2024/Models/EventDocument.md | 2 +- .../V2024/Models/ExceptionCriteria.md | 2 +- .../V2024/Models/ExceptionCriteriaAccess.md | 2 +- .../ExceptionCriteriaCriteriaListInner.md | 2 +- .../Reference/V2024/Models/ExportOptions.md | 2 +- .../Reference/V2024/Models/ExportPayload.md | 2 +- .../Reference/V2024/Models/FieldDetailsDto.md | 4 +- .../Reference/V2024/Models/FirstValid.md | 2 +- .../FormDefinitionDynamicSchemaResponse.md | 2 +- .../Reference/V2024/Models/FormElement.md | 2 +- .../V2024/Models/FormInstanceResponse.md | 4 +- ...istoricalIdentityEvents200ResponseInner.md | 4 +- .../GetRoleAssignments200ResponseInner.md | 4 +- .../Reference/V2024/Models/ISO3166.md | 2 +- .../Reference/V2024/Models/Identity.md | 2 +- .../Reference/V2024/Models/IdentityAccess.md | 2 +- ...sociationDetailsAssociationDetailsInner.md | 2 +- .../V2024/Models/IdentityAttribute1.md | 2 +- .../V2024/Models/IdentityAttributeConfig.md | 2 +- .../Models/IdentityAttributeTransform.md | 2 +- .../V2024/Models/IdentityCertified.md | 4 +- .../Reference/V2024/Models/IdentityCreated.md | 2 +- .../Reference/V2024/Models/IdentityDeleted.md | 2 +- .../V2024/Models/IdentityDocument.md | 2 +- .../IdentityExceptionReportReference.md | 4 +- .../V2024/Models/IdentityHistoryResponse.md | 4 +- ...sociationDetailsAssociationDetailsInner.md | 2 +- .../Reference/V2024/Models/IdentityProfile.md | 10 +- ...IdentityProfileAllOfAuthoritativeSource.md | 6 +- .../V2024/Models/IdentityProfileAllOfOwner.md | 6 +- .../V2024/Models/IdentitySyncPayload.md | 2 +- .../V2024/Models/IdentityWithNewAccess.md | 2 +- .../V2024/Models/IdentityWithNewAccess1.md | 2 +- .../IdentityWithNewAccessAccessRefsInner.md | 2 +- .../Reference/V2024/Models/ImportOptions.md | 2 +- .../Reference/V2024/Models/IndexOf.md | 2 +- .../Reference/V2024/Models/InnerHit.md | 2 +- .../Reference/V2024/Models/Invocation.md | 2 +- .../V2024/Models/KbaAnswerResponseItem.md | 2 +- .../Reference/V2024/Models/KbaQuestion.md | 2 +- .../Reference/V2024/Models/LeftPad.md | 2 +- ...CompleteWorkflowLibrary200ResponseInner.md | 4 +- .../ListFormElementDataByElementIDResponse.md | 2 +- .../V2024/Models/LoadEntitlementTask.md | 2 +- .../LoadUncorrelatedAccountsTaskTask.md | 2 +- .../Reference/V2024/Models/Lookup.md | 4 +- .../Reference/V2024/Models/Lower.md | 2 +- .../Reference/V2024/Models/MachineAccount.md | 75 - .../Reference/V2024/Models/MachineIdentity.md | 49 - .../V2024/Models/MailFromAttributes.md | 2 +- .../V2024/Models/ManagedClientStatus.md | 2 +- .../Reference/V2024/Models/ManagedCluster.md | 2 +- .../V2024/Models/ManagedClusterRequest.md | 2 +- .../Models/ManualDiscoverApplications.md | 4 +- .../Reference/V2024/Models/MatchTerm.md | 2 +- .../Reference/V2024/Models/MfaDuoConfig.md | 2 +- .../Reference/V2024/Models/NameNormalizer.md | 2 +- .../V2024/Models/NonEmployeeRecord.md | 2 +- .../V2024/Models/NonEmployeeRequest.md | 2 +- .../V2024/Models/NonEmployeeRequestBody.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 6 +- .../Models/NonEmployeeSourceWithNECount.md | 2 +- .../Models/NotificationTemplateContext.md | 2 +- .../Models/ObjectMappingBulkPatchRequest.md | 2 +- .../Reference/V2024/Models/OrgConfig.md | 4 +- .../Reference/V2024/Models/OriginalRequest.md | 2 +- .../Reference/V2024/Models/Outlier.md | 2 +- .../V2024/Models/OutlierFeatureSummary.md | 2 +- .../V2024/Models/PasswordChangeRequest.md | 4 +- .../V2024/Models/PasswordInfoAccount.md | 2 +- .../Models/PasswordPolicyHoldersDtoInner.md | 2 +- .../V2024/Models/PreviewDataSourceResponse.md | 2 +- .../V2024/Models/ProcessingDetails.md | 4 +- .../Reference/V2024/Models/Product.md | 2 +- ...ovisioningCompletedAccountRequestsInner.md | 2 +- ...ountRequestsInnerAttributeRequestsInner.md | 2 +- .../V2024/Models/ProvisioningConfig.md | 2 +- .../V2024/Models/ProvisioningConfig1.md | 2 +- ...rovisioningConfig1PlanInitializerScript.md | 2 +- ...ProvisioningConfigPlanInitializerScript.md | 2 +- .../V2024/Models/RandomAlphaNumeric.md | 2 +- .../Reference/V2024/Models/RandomNumeric.md | 2 +- .../V2024/Models/RecommendationResponse.md | 2 +- .../Reference/V2024/Models/Reference.md | 2 +- .../Reference/V2024/Models/Replace.md | 2 +- .../Reference/V2024/Models/ReplaceAll.md | 4 +- .../V2024/Models/RequestedItemStatus.md | 2 +- .../Reference/V2024/Models/ResourceObject.md | 4 +- .../V2024/Models/ReviewableEntitlement.md | 4 +- .../Models/ReviewableEntitlementAccount.md | 2 +- .../Reference/V2024/Models/RightPad.md | 2 +- .../powershell/Reference/V2024/Models/Role.md | 2 +- .../V2024/Models/RoleAssignmentDto.md | 4 +- .../Models/RoleDocumentAllOfEntitlements.md | 4 +- .../Models/RoleDocumentAllOfEntitlements1.md | 4 +- .../V2024/Models/RoleListFilterDTO.md | 2 +- .../RoleMetadataBulkUpdateByFilterRequest.md | 2 +- .../RoleMetadataBulkUpdateByIdRequest.md | 2 +- .../RoleMetadataBulkUpdateByQueryRequest.md | 2 +- .../Models/RoleMiningIdentityDistribution.md | 2 +- .../RoleMiningPotentialRoleApplication.md | 4 +- .../RoleMiningPotentialRoleEntitlements.md | 4 +- .../V2024/Models/RoleMiningSessionScope.md | 2 +- .../Reference/V2024/Models/SavedSearch.md | 4 +- .../V2024/Models/SavedSearchComplete.md | 2 +- .../V2024/Models/SavedSearchDetail.md | 4 +- .../Reference/V2024/Models/Schedule2Days.md | 2 +- .../Reference/V2024/Models/Schedule2Hours.md | 2 +- .../Reference/V2024/Models/Schedule2Months.md | 2 +- .../Reference/V2024/Models/Schema.md | 4 +- .../Reference/V2024/Models/Scope.md | 2 +- .../Reference/V2024/Models/Search.md | 2 +- .../V2024/Models/SearchAttributeConfig.md | 2 +- .../Reference/V2024/Models/Selector.md | 2 +- ...lectorAccountMatchConfigMatchExpression.md | 2 +- .../V2024/Models/ServiceDeskIntegrationDto.md | 2 +- .../Models/ServiceDeskIntegrationDto1.md | 2 +- .../ServiceDeskIntegrationTemplateDto.md | 2 +- .../V2024/Models/SimIntegrationDetails.md | 6 +- .../Reference/V2024/Models/SodPolicy.md | 2 +- .../V2024/Models/SodViolationCheckResult.md | 2 +- .../V2024/Models/SodViolationCheckResult1.md | 2 +- .../Reference/V2024/Models/Source.md | 6 +- .../Reference/V2024/Models/Source1.md | 2 +- .../V2024/Models/SourceAccountCreated.md | 2 +- .../V2024/Models/SourceAccountDeleted.md | 2 +- .../V2024/Models/SourceAccountUpdated.md | 2 +- .../V2024/Models/SourceAppAccountSource.md | 2 +- .../Models/SourceAppBulkUpdateRequest.md | 2 +- .../Reference/V2024/Models/SourceCode.md | 2 +- .../V2024/Models/SourceSyncPayload.md | 2 +- .../Reference/V2024/Models/SourceUsage.md | 2 +- .../V2024/Models/SpConfigImportResults.md | 2 +- .../Reference/V2024/Models/SpConfigMessage.md | 2 +- .../V2024/Models/SpConfigMessage1.md | 2 +- .../Reference/V2024/Models/SpConfigObject.md | 2 - .../Reference/V2024/Models/SpConfigRule.md | 6 +- .../V2024/Models/SpConfigRuleValue.md | 34 - .../Reference/V2024/Models/Split.md | 2 +- .../V2024/Models/StartInvocationInput.md | 4 +- .../Reference/V2024/Models/StatusResponse.md | 2 +- .../Reference/V2024/Models/Subscription.md | 2 +- .../V2024/Models/SubscriptionPostRequest.md | 2 +- .../V2024/Models/SubscriptionPutRequest.md | 2 +- .../Reference/V2024/Models/Substring.md | 2 +- .../V2024/Models/TaskResultDetails.md | 2 +- .../Reference/V2024/Models/TaskStatus.md | 2 +- .../V2024/Models/TaskStatusMessage.md | 2 +- .../Reference/V2024/Models/TemplateDto.md | 2 +- .../V2024/Models/TemplateDtoDefault.md | 2 +- .../TestExternalExecuteWorkflow200Response.md | 2 +- .../TestExternalExecuteWorkflowRequest.md | 2 +- .../Reference/V2024/Models/TestInvocation.md | 4 +- .../V2024/Models/TransformAttributes.md | 8 +- .../V2024/Models/TransformDefinition.md | 4 +- .../Reference/V2024/Models/Trigger.md | 4 +- .../V2024/Models/TriggerExampleInput.md | 4 +- .../powershell/Reference/V2024/Models/Trim.md | 2 +- .../Reference/V2024/Models/Upper.md | 2 +- .../Reference/V2024/Models/V3ConnectorDto.md | 2 +- .../V2024/Models/ValidateFilterInputDto.md | 4 +- .../Reference/V2024/Models/WorkItemForward.md | 2 +- .../Reference/V2024/Models/WorkItems.md | 2 +- .../Reference/V2024/Models/Workflow.md | 2 +- .../Reference/V2024/Models/WorkflowBody.md | 2 +- .../V2024/Models/WorkflowDefinition.md | 2 +- .../V2024/Models/WorkflowExecution.md | 2 +- .../V2024/Models/WorkflowLibraryAction.md | 2 +- .../V2024/Models/WorkflowLibraryOperator.md | 2 +- .../V2024/Models/WorkflowLibraryTrigger.md | 2 +- .../V2024/Models/WorkflowTriggerAttributes.md | 2 +- .../V2024/Models/WorkgroupDeleteItem.md | 6 +- .../V2024/Models/WorkgroupMemberAddItem.md | 4 +- .../V2024/Models/WorkgroupMemberDeleteItem.md | 4 +- .../Reference/V3/Methods/AccountsApi.md | 8 +- .../V3/Methods/IdentityProfilesApi.md | 68 +- .../NonEmployeeLifecycleManagementApi.md | 22 +- .../Reference/V3/Models/AccessCriteria.md | 2 +- .../V3/Models/AccessProfileEntitlement.md | 2 +- .../Reference/V3/Models/AccessRequest.md | 2 +- .../Reference/V3/Models/AccessRequestItem.md | 2 +- .../V3/Models/AccessRequestResponse.md | 4 +- .../V3/Models/AccessRequestTracking.md | 4 +- .../powershell/Reference/V3/Models/Account.md | 2 +- .../Reference/V3/Models/AccountActivity.md | 2 +- .../V3/Models/AccountActivityItem.md | 2 +- .../Reference/V3/Models/AccountAttribute.md | 6 +- .../Reference/V3/Models/AccountAttributes.md | 2 +- .../Reference/V3/Models/AccountUsage.md | 2 +- .../Reference/V3/Models/AggregationResult.md | 2 +- .../Reference/V3/Models/AppAllOfAccount.md | 2 +- .../Reference/V3/Models/AttributeDTOList.md | 2 +- .../Reference/V3/Models/BackupOptions.md | 2 +- .../Reference/V3/Models/Base64Decode.md | 2 +- .../Reference/V3/Models/Base64Encode.md | 2 +- .../Reference/V3/Models/BaseAccount.md | 4 +- .../Reference/V3/Models/BaseEntitlement.md | 4 +- .../V3/Models/CampaignFilterDetails.md | 4 +- .../Reference/V3/Models/CertificationTask.md | 2 +- .../Reference/V3/Models/CompletedApproval.md | 2 +- .../Reference/V3/Models/Concatenation.md | 2 +- .../Reference/V3/Models/Conditional.md | 2 +- .../Reference/V3/Models/ConnectorDetail.md | 94 +- .../CreateExternalExecuteWorkflowRequest.md | 2 +- .../V3/Models/CreateSavedSearchRequest.md | 4 +- .../V3/Models/CreateWorkflowRequest.md | 2 +- .../Reference/V3/Models/DateCompare.md | 2 +- .../V3/Models/DateCompareFirstDate.md | 6 +- .../V3/Models/DateCompareSecondDate.md | 6 +- .../Reference/V3/Models/DateFormat.md | 2 +- .../Reference/V3/Models/DateMath.md | 2 +- .../V3/Models/DecomposeDiacriticalMarks.md | 2 +- .../Reference/V3/Models/E164phone.md | 2 +- .../Reference/V3/Models/Entitlement.md | 6 +- .../Reference/V3/Models/EntitlementDto.md | 4 +- .../Reference/V3/Models/EntitlementRef.md | 2 +- .../Reference/V3/Models/EntitlementRef1.md | 2 +- .../Reference/V3/Models/EntitlementSummary.md | 2 +- .../powershell/Reference/V3/Models/Event.md | 2 +- .../Reference/V3/Models/EventAttributes.md | 4 +- .../Reference/V3/Models/EventDocument.md | 2 +- .../Reference/V3/Models/ExceptionCriteria.md | 2 +- .../V3/Models/ExceptionCriteriaAccess.md | 2 +- .../ExceptionCriteriaCriteriaListInner.md | 2 +- .../Reference/V3/Models/FieldDetailsDto.md | 4 +- .../Reference/V3/Models/FirstValid.md | 2 +- .../powershell/Reference/V3/Models/ISO3166.md | 2 +- .../Reference/V3/Models/IdentityAccess.md | 2 +- .../Reference/V3/Models/IdentityAttribute.md | 2 +- .../V3/Models/IdentityAttributeConfig.md | 2 +- .../V3/Models/IdentityAttributeTransform.md | 2 +- .../Reference/V3/Models/IdentityDocument.md | 2 +- .../IdentityExceptionReportReference.md | 4 +- .../Reference/V3/Models/IdentityProfile.md | 10 +- ...IdentityProfileAllOfAuthoritativeSource.md | 6 +- .../V3/Models/IdentityProfileAllOfOwner.md | 6 +- .../V3/Models/IdentityWithNewAccess.md | 2 +- .../V3/Models/IdentityWithNewAccess1.md | 2 +- .../IdentityWithNewAccessAccessRefsInner.md | 2 +- .../Reference/V3/Models/IdpDetails.md | 2 +- .../powershell/Reference/V3/Models/IndexOf.md | 2 +- .../Reference/V3/Models/InnerHit.md | 2 +- .../Reference/V3/Models/JITConfiguration.md | 2 +- .../V3/Models/KbaAnswerResponseItem.md | 2 +- .../Reference/V3/Models/KbaAuthResponse.md | 2 +- .../Reference/V3/Models/KbaQuestion.md | 2 +- .../powershell/Reference/V3/Models/LeftPad.md | 2 +- ...CompleteWorkflowLibrary200ResponseInner.md | 4 +- .../powershell/Reference/V3/Models/Lookup.md | 4 +- .../powershell/Reference/V3/Models/Lower.md | 2 +- .../V3/Models/ManagedClientStatus.md | 2 +- .../Reference/V3/Models/ManagedCluster.md | 2 +- .../V3/Models/ManagedClusterRequest.md | 2 +- .../V3/Models/ManualDiscoverApplications.md | 4 +- .../Reference/V3/Models/MfaDuoConfig.md | 2 +- .../Reference/V3/Models/NameNormalizer.md | 2 +- .../Reference/V3/Models/NonEmployeeRecord.md | 2 +- .../Reference/V3/Models/NonEmployeeRequest.md | 2 +- .../V3/Models/NonEmployeeRequestBody.md | 2 +- .../NonEmployeeRequestWithoutApprovalItem.md | 6 +- .../V3/Models/NonEmployeeSourceWithNECount.md | 2 +- .../Models/ObjectMappingBulkPatchRequest.md | 2 +- .../Reference/V3/Models/OriginalRequest.md | 2 +- .../V3/Models/PasswordChangeRequest.md | 4 +- .../V3/Models/PasswordInfoAccount.md | 2 +- .../Reference/V3/Models/ProcessingDetails.md | 4 +- .../Reference/V3/Models/ProvisioningConfig.md | 2 +- ...ProvisioningConfigPlanInitializerScript.md | 2 +- .../Reference/V3/Models/RandomAlphaNumeric.md | 2 +- .../Reference/V3/Models/RandomNumeric.md | 2 +- .../Reference/V3/Models/Reference.md | 2 +- .../powershell/Reference/V3/Models/Replace.md | 2 +- .../Reference/V3/Models/ReplaceAll.md | 4 +- .../V3/Models/RequestedItemStatus.md | 2 +- .../V3/Models/ReviewableEntitlement.md | 4 +- .../V3/Models/ReviewableEntitlementAccount.md | 2 +- .../Reference/V3/Models/RightPad.md | 2 +- .../powershell/Reference/V3/Models/Role.md | 2 +- .../Models/RoleDocumentAllOfEntitlements.md | 4 +- .../Models/RoleDocumentAllOfEntitlements1.md | 4 +- .../Reference/V3/Models/SavedSearch.md | 4 +- .../Reference/V3/Models/SavedSearchDetail.md | 4 +- .../powershell/Reference/V3/Models/Schema.md | 4 +- .../powershell/Reference/V3/Models/Search.md | 2 +- .../V3/Models/SearchAttributeConfig.md | 2 +- .../V3/Models/ServiceDeskIntegrationDto.md | 2 +- .../ServiceDeskIntegrationTemplateDto.md | 2 +- .../V3/Models/ServiceProviderConfiguration.md | 2 +- ...igurationFederationProtocolDetailsInner.md | 2 +- .../Reference/V3/Models/SodPolicy.md | 2 +- .../V3/Models/SodViolationCheckResult.md | 2 +- .../powershell/Reference/V3/Models/Source.md | 6 +- .../Reference/V3/Models/SourceUsage.md | 2 +- .../Reference/V3/Models/SpConfigMessage.md | 2 +- .../powershell/Reference/V3/Models/Split.md | 2 +- .../Reference/V3/Models/Substring.md | 2 +- .../Reference/V3/Models/TaskResultDetails.md | 2 +- .../TestExternalExecuteWorkflow200Response.md | 2 +- .../TestExternalExecuteWorkflowRequest.md | 2 +- .../V3/Models/TransformAttributes.md | 8 +- .../V3/Models/TransformDefinition.md | 4 +- .../powershell/Reference/V3/Models/Trim.md | 2 +- .../powershell/Reference/V3/Models/Upper.md | 2 +- .../Reference/V3/Models/V3ConnectorDto.md | 2 +- .../Reference/V3/Models/WorkItemForward.md | 2 +- .../Reference/V3/Models/WorkItems.md | 2 +- .../Reference/V3/Models/Workflow.md | 2 +- .../Reference/V3/Models/WorkflowBody.md | 2 +- .../Reference/V3/Models/WorkflowDefinition.md | 2 +- .../Reference/V3/Models/WorkflowExecution.md | 2 +- .../V3/Models/WorkflowLibraryAction.md | 2 +- .../V3/Models/WorkflowLibraryOperator.md | 2 +- .../V3/Models/WorkflowLibraryTrigger.md | 2 +- .../V3/Models/WorkflowTriggerAttributes.md | 2 +- .../beta/code_examples_overlay.yaml | 3070 ++++----- .../v2024/code_examples_overlay.yaml | 5691 ++++++++--------- .../v3/code_examples_overlay.yaml | 3976 ++++++------ 724 files changed, 8185 insertions(+), 9145 deletions(-) delete mode 100644 docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRuleValue.md delete mode 100644 docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md delete mode 100644 docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md delete mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md delete mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/MachineAccount.md delete mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/MachineIdentity.md delete mode 100644 docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRuleValue.md diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md index b8d1d720e922..ac4c7efb3691 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md @@ -182,10 +182,10 @@ $AccessProfile = @"{ try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-BetaAccessProfile -BetaAccessProfile $Result + New-BetaAccessProfile -AccessProfile $Result # Below is a request that includes all optional parameters - # New-BetaAccessProfile -BetaAccessProfile $Result + # New-BetaAccessProfile -AccessProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile" Write-Host $_.ErrorDetails @@ -284,10 +284,10 @@ $AccessProfileBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $Result + Remove-BetaAccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $Result + # Remove-BetaAccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk" Write-Host $_.ErrorDetails @@ -503,10 +503,10 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaAccessProfile -Id $Id -BetaJsonPatchOperation $Result + Update-BetaAccessProfile -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaAccessProfile -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaAccessProfile -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile" Write-Host $_.ErrorDetails @@ -557,10 +557,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner - Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $Result + Update-BetaAccessProfilesInBulk -AccessProfileBulkUpdateRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $Result + # Update-BetaAccessProfilesInBulk -AccessProfileBulkUpdateRequestInner $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 432d6412bb6e..1b8cae37259c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md @@ -88,10 +88,10 @@ $CommentDto = @"{ try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Approve-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result + Approve-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result # Below is a request that includes all optional parameters - # Approve-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result + # Approve-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest" Write-Host $_.ErrorDetails @@ -140,10 +140,10 @@ $ForwardApprovalDto = @"{ try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -BetaForwardApprovalDto $Result + Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result # Below is a request that includes all optional parameters - # Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -BetaForwardApprovalDto $Result + # Invoke-BetaForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest" Write-Host $_.ErrorDetails @@ -352,10 +352,10 @@ $CommentDto = @"{ try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result + Deny-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $Result # Below is a request that includes all optional parameters - # Deny-BetaAccessRequest -ApprovalId $ApprovalId -BetaCommentDto $Result + # Deny-BetaAccessRequest -ApprovalId $ApprovalId -CommentDto $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/BetaAccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md index 34e352dca968..76015f4bf64b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md @@ -80,10 +80,10 @@ $CancelAccessRequest = @"{ try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-BetaAccessRequest -BetaCancelAccessRequest $Result + Suspend-BetaAccessRequest -CancelAccessRequest $Result # Below is a request that includes all optional parameters - # Suspend-BetaAccessRequest -BetaCancelAccessRequest $Result + # Suspend-BetaAccessRequest -CancelAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest" Write-Host $_.ErrorDetails @@ -142,10 +142,10 @@ $CloseAccessRequest = @"{ try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest - Close-BetaAccessRequest -BetaCloseAccessRequest $Result + Close-BetaAccessRequest -CloseAccessRequest $Result # Below is a request that includes all optional parameters - # Close-BetaAccessRequest -BetaCloseAccessRequest $Result + # Close-BetaAccessRequest -CloseAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest" Write-Host $_.ErrorDetails @@ -271,10 +271,10 @@ $AccessRequest = @"{ try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-BetaAccessRequest -BetaAccessRequest $Result + New-BetaAccessRequest -AccessRequest $Result # Below is a request that includes all optional parameters - # New-BetaAccessRequest -BetaAccessRequest $Result + # New-BetaAccessRequest -AccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest" Write-Host $_.ErrorDetails @@ -450,10 +450,10 @@ $AccessRequestConfig = @"{ try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-BetaAccessRequestConfig -BetaAccessRequestConfig $Result + Set-BetaAccessRequestConfig -AccessRequestConfig $Result # Below is a request that includes all optional parameters - # Set-BetaAccessRequestConfig -BetaAccessRequestConfig $Result + # Set-BetaAccessRequestConfig -AccessRequestConfig $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/BetaAccountsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md index d172ab770664..0407500d0a09 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md @@ -117,10 +117,10 @@ $AccountAttributesCreate = @"{ try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-BetaAccount -BetaAccountAttributesCreate $Result + New-BetaAccount -AccountAttributesCreate $Result # Below is a request that includes all optional parameters - # New-BetaAccount -BetaAccountAttributesCreate $Result + # New-BetaAccount -AccountAttributesCreate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount" Write-Host $_.ErrorDetails @@ -271,10 +271,10 @@ $AccountToggleRequest = @"{ try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result + Disable-BetaAccount -Id $Id -AccountToggleRequest $Result # Below is a request that includes all optional parameters - # Disable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result + # Disable-BetaAccount -Id $Id -AccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount" Write-Host $_.ErrorDetails @@ -365,10 +365,10 @@ $IdentitiesAccountsBulkRequest = @"{ try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result + Disable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters - # Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result + # Disable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities" Write-Host $_.ErrorDetails @@ -418,10 +418,10 @@ $AccountToggleRequest = @"{ try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result + Enable-BetaAccount -Id $Id -AccountToggleRequest $Result # Below is a request that includes all optional parameters - # Enable-BetaAccount -Id $Id -BetaAccountToggleRequest $Result + # Enable-BetaAccount -Id $Id -AccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount" Write-Host $_.ErrorDetails @@ -512,10 +512,10 @@ $IdentitiesAccountsBulkRequest = @"{ try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result + Enable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters - # Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $Result + # Enable-BetaAccountsForIdentities -IdentitiesAccountsBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities" Write-Host $_.ErrorDetails @@ -635,8 +635,8 @@ 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* - 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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** + 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* + 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: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** ### Return type [**Account[]**](../models/account) @@ -661,8 +661,8 @@ $DetailLevel = "SLIM" # String | This value determines whether the API provides $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 = 'identityId eq "2c9180858082150f0180893dbaf44201"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) +$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (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, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # Accounts List @@ -731,10 +731,10 @@ $AccountAttributes = @"{ try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-BetaAccount -Id $Id -BetaAccountAttributes $Result + Send-BetaAccount -Id $Id -AccountAttributes $Result # Below is a request that includes all optional parameters - # Send-BetaAccount -Id $Id -BetaAccountAttributes $Result + # Send-BetaAccount -Id $Id -AccountAttributes $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount" Write-Host $_.ErrorDetails @@ -833,10 +833,10 @@ $AccountUnlockRequest = @"{ try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-BetaAccount -Id $Id -BetaAccountUnlockRequest $Result + Unlock-BetaAccount -Id $Id -AccountUnlockRequest $Result # Below is a request that includes all optional parameters - # Unlock-BetaAccount -Id $Id -BetaAccountUnlockRequest $Result + # Unlock-BetaAccount -Id $Id -AccountUnlockRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-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 b6371f436598..1cbd95203e29 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md @@ -217,7 +217,7 @@ try { Update-BetaDiscoveredApplicationByID -Id $Id # Below is a request that includes all optional parameters - # Update-BetaDiscoveredApplicationByID -Id $Id -BetaJsonPatchOperations $Result + # Update-BetaDiscoveredApplicationByID -Id $Id -JsonPatchOperations $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID" 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 bccd06fac6aa..4e236b33b72d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md @@ -79,10 +79,10 @@ $SourceAppCreateDto = @"{ try { $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto - New-BetaSourceApp -BetaSourceAppCreateDto $Result + New-BetaSourceApp -SourceAppCreateDto $Result # Below is a request that includes all optional parameters - # New-BetaSourceApp -BetaSourceAppCreateDto $Result + # New-BetaSourceApp -SourceAppCreateDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp" Write-Host $_.ErrorDetails @@ -646,7 +646,7 @@ try { Update-BetaSourceApp -Id $Id # Below is a request that includes all optional parameters - # Update-BetaSourceApp -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaSourceApp -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp" Write-Host $_.ErrorDetails @@ -700,7 +700,7 @@ try { Update-BetaUserApp -Id $Id # Below is a request that includes all optional parameters - # Update-BetaUserApp -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaUserApp -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp" Write-Host $_.ErrorDetails @@ -759,7 +759,7 @@ try { Update-BetaSourceAppsInBulk # Below is a request that includes all optional parameters - # Update-BetaSourceAppsInBulk -BetaSourceAppBulkUpdateRequest $Result + # Update-BetaSourceAppsInBulk -SourceAppBulkUpdateRequest $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 a86868e1296a..c9528bdfbe1d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md @@ -160,10 +160,10 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to pa try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaProfileConfig -Id $Id -BetaJsonPatchOperation $Result + Update-BetaProfileConfig -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaProfileConfig -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaProfileConfig -Id $Id -JsonPatchOperation $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 5e29675f376a..7ebca88711ae 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md @@ -163,7 +163,7 @@ try { Complete-BetaCampaign -Id $Id # Below is a request that includes all optional parameters - # Complete-BetaCampaign -Id $Id -BetaCompleteCampaignOptions $Result + # Complete-BetaCampaign -Id $Id -CompleteCampaignOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign" Write-Host $_.ErrorDetails @@ -320,10 +320,10 @@ $Campaign = @"{ try { $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-BetaCampaign -BetaCampaign $Result + New-BetaCampaign -Campaign $Result # Below is a request that includes all optional parameters - # New-BetaCampaign -BetaCampaign $Result + # New-BetaCampaign -Campaign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign" Write-Host $_.ErrorDetails @@ -495,10 +495,10 @@ $CampaignTemplate = @"{ try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-BetaCampaignTemplate -BetaCampaignTemplate $Result + New-BetaCampaignTemplate -CampaignTemplate $Result # Below is a request that includes all optional parameters - # New-BetaCampaignTemplate -BetaCampaignTemplate $Result + # New-BetaCampaignTemplate -CampaignTemplate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate" Write-Host $_.ErrorDetails @@ -654,10 +654,10 @@ $DeleteCampaignsRequest = @"{ try { $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest - Remove-BetaCampaigns -BetaDeleteCampaignsRequest $Result + Remove-BetaCampaigns -DeleteCampaignsRequest $Result # Below is a request that includes all optional parameters - # Remove-BetaCampaigns -BetaDeleteCampaignsRequest $Result + # Remove-BetaCampaigns -DeleteCampaignsRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns" Write-Host $_.ErrorDetails @@ -1095,10 +1095,10 @@ $AdminReviewReassign = @"{ try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move-Beta -Id $Id -BetaAdminReviewReassign $Result + Move-Beta -Id $Id -AdminReviewReassign $Result # Below is a request that includes all optional parameters - # Move-Beta -Id $Id -BetaAdminReviewReassign $Result + # Move-Beta -Id $Id -AdminReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta" Write-Host $_.ErrorDetails @@ -1155,10 +1155,10 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaCampaignTemplate -Id $Id -BetaJsonPatchOperation $Result + Update-BetaCampaignTemplate -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaCampaignTemplate -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaCampaignTemplate -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate" Write-Host $_.ErrorDetails @@ -1209,10 +1209,10 @@ $CampaignReportsConfig = @"{ try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $Result + Set-BetaCampaignReportsConfig -CampaignReportsConfig $Result # Below is a request that includes all optional parameters - # Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $Result + # Set-BetaCampaignReportsConfig -CampaignReportsConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig" Write-Host $_.ErrorDetails @@ -1286,7 +1286,7 @@ try { Set-BetaCampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters - # Set-BetaCampaignTemplateSchedule -Id $Id -BetaSchedule $Result + # Set-BetaCampaignTemplateSchedule -Id $Id -Schedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule" Write-Host $_.ErrorDetails @@ -1342,7 +1342,7 @@ try { Start-BetaCampaign -Id $Id # Below is a request that includes all optional parameters - # Start-BetaCampaign -Id $Id -BetaActivateCampaignOptions $Result + # Start-BetaCampaign -Id $Id -ActivateCampaignOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-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 9931e81fc8a4..1a15ff48a354 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md @@ -358,10 +358,10 @@ $ReviewReassign = @"{ try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-BetaReassignCertsAsync -Id $Id -BetaReviewReassign $Result + Submit-BetaReassignCertsAsync -Id $Id -ReviewReassign $Result # Below is a request that includes all optional parameters - # Submit-BetaReassignCertsAsync -Id $Id -BetaReviewReassign $Result + # Submit-BetaReassignCertsAsync -Id $Id -ReviewReassign $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 87ddbe6d6dfb..4130d6af23fd 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md @@ -92,10 +92,10 @@ $ConnectorRuleCreateRequest = @"{ try { $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest - New-BetaConnectorRule -BetaConnectorRuleCreateRequest $Result + New-BetaConnectorRule -ConnectorRuleCreateRequest $Result # Below is a request that includes all optional parameters - # New-BetaConnectorRule -BetaConnectorRuleCreateRequest $Result + # New-BetaConnectorRule -ConnectorRuleCreateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule" Write-Host $_.ErrorDetails @@ -308,7 +308,7 @@ try { Update-BetaConnectorRule -Id $Id # Below is a request that includes all optional parameters - # Update-BetaConnectorRule -Id $Id -BetaConnectorRuleUpdateRequest $Result + # Update-BetaConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule" Write-Host $_.ErrorDetails @@ -355,10 +355,10 @@ $SourceCode = @"{ try { $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode - Confirm-BetaConnectorRule -BetaSourceCode $Result + Confirm-BetaConnectorRule -SourceCode $Result # Below is a request that includes all optional parameters - # Confirm-BetaConnectorRule -BetaSourceCode $Result + # Confirm-BetaConnectorRule -SourceCode $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/BetaCustomFormsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md index e38391a99ff2..c0eb8841fa14 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md @@ -193,7 +193,7 @@ try { New-BetaFormDefinition # Below is a request that includes all optional parameters - # New-BetaFormDefinition -BetaCreateFormDefinitionRequest $Result + # New-BetaFormDefinition -CreateFormDefinitionRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition" Write-Host $_.ErrorDetails @@ -348,7 +348,7 @@ try { New-BetaFormDefinitionByTemplate # Below is a request that includes all optional parameters - # New-BetaFormDefinitionByTemplate -BetaCreateFormDefinitionRequest $Result + # New-BetaFormDefinitionByTemplate -CreateFormDefinitionRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate" Write-Host $_.ErrorDetails @@ -402,7 +402,7 @@ try { New-BetaFormDefinitionDynamicSchema # Below is a request that includes all optional parameters - # New-BetaFormDefinitionDynamicSchema -BetaBody $Result + # New-BetaFormDefinitionDynamicSchema -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema" Write-Host $_.ErrorDetails @@ -518,7 +518,7 @@ try { New-BetaFormInstance # Below is a request that includes all optional parameters - # New-BetaFormInstance -BetaBody $Result + # New-BetaFormInstance -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance" Write-Host $_.ErrorDetails @@ -857,7 +857,7 @@ try { Import-BetaFormDefinitions # Below is a request that includes all optional parameters - # Import-BetaFormDefinitions -BetaBody $Result + # Import-BetaFormDefinitions -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions" Write-Host $_.ErrorDetails @@ -1214,7 +1214,7 @@ try { Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID # Below is a request that includes all optional parameters - # Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -BetaFormElementPreviewRequest $Result + # Show-BetaPreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $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 61aafa146c6a..f9235c3f4325 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md @@ -70,10 +70,10 @@ $CustomPasswordInstruction = @"{ try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction - New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $Result + New-BetaCustomPasswordInstructions -CustomPasswordInstruction $Result # Below is a request that includes all optional parameters - # New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $Result + # New-BetaCustomPasswordInstructions -CustomPasswordInstruction $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-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 eeca2d278dc2..4a3a99dee4a1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md @@ -552,7 +552,7 @@ try { Update-BetaEntitlement -Id $Id # Below is a request that includes all optional parameters - # Update-BetaEntitlement -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaEntitlement -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement" Write-Host $_.ErrorDetails @@ -610,10 +610,10 @@ $EntitlementRequestConfig = @"{ try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig - Send-BetaEntitlementRequestConfig -Id $Id -BetaEntitlementRequestConfig $Result + Send-BetaEntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result # Below is a request that includes all optional parameters - # Send-BetaEntitlementRequestConfig -Id $Id -BetaEntitlementRequestConfig $Result + # Send-BetaEntitlementRequestConfig -Id $Id -EntitlementRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig" Write-Host $_.ErrorDetails @@ -726,10 +726,10 @@ $EntitlementBulkUpdateRequest = @"{ try { $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest - Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $Result + Update-BetaEntitlementsInBulk -EntitlementBulkUpdateRequest $Result # Below is a request that includes all optional parameters - # Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $Result + # Update-BetaEntitlementsInBulk -EntitlementBulkUpdateRequest $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 0712cfa733c9..d21ade854001 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md @@ -84,10 +84,10 @@ $WorkgroupDto = @"{ try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto - New-BetaWorkgroup -BetaWorkgroupDto $Result + New-BetaWorkgroup -WorkgroupDto $Result # Below is a request that includes all optional parameters - # New-BetaWorkgroup -BetaWorkgroupDto $Result + # New-BetaWorkgroup -WorkgroupDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup" Write-Host $_.ErrorDetails @@ -182,10 +182,10 @@ $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governanc try { $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner - Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result # Below is a request that includes all optional parameters - # Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + # Remove-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers" Write-Host $_.ErrorDetails @@ -241,10 +241,10 @@ $WorkgroupBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest - Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $Result + Remove-BetaWorkgroupsInBulk -WorkgroupBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $Result + # Remove-BetaWorkgroupsInBulk -WorkgroupBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk" Write-Host $_.ErrorDetails @@ -506,7 +506,7 @@ try { Update-BetaWorkgroup -Id $Id # Below is a request that includes all optional parameters - # Update-BetaWorkgroup -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaWorkgroup -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup" Write-Host $_.ErrorDetails @@ -556,10 +556,10 @@ $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governanc try { $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner - Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + # Update-BetaWorkgroupMembers -WorkgroupId $WorkgroupId -BulkWorkgroupMembersRequestInner $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 385be8d41094..39a48036be64 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md @@ -68,10 +68,10 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $Result + Add-BetaAccessRequestRecommendationsIgnoredItem -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $Result + # Add-BetaAccessRequestRecommendationsIgnoredItem -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem" Write-Host $_.ErrorDetails @@ -120,10 +120,10 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $Result + Add-BetaAccessRequestRecommendationsRequestedItem -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $Result + # Add-BetaAccessRequestRecommendationsRequestedItem -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem" Write-Host $_.ErrorDetails @@ -172,10 +172,10 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $Result + Add-BetaAccessRequestRecommendationsViewedItem -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $Result + # Add-BetaAccessRequestRecommendationsViewedItem -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem" Write-Host $_.ErrorDetails @@ -225,10 +225,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $Result + Add-BetaAccessRequestRecommendationsViewedItems -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $Result + # Add-BetaAccessRequestRecommendationsViewedItems -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-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 1cabbf235c3b..69a4420969b2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAICommonAccessApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAICommonAccessApi.md @@ -67,10 +67,10 @@ $CommonAccessItemRequest = @"{ try { $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest - New-BetaCommonAccess -BetaCommonAccessItemRequest $Result + New-BetaCommonAccess -CommonAccessItemRequest $Result # Below is a request that includes all optional parameters - # New-BetaCommonAccess -BetaCommonAccessItemRequest $Result + # New-BetaCommonAccess -CommonAccessItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess" Write-Host $_.ErrorDetails @@ -169,10 +169,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus - Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $Result + Update-BetaCommonAccessStatusInBulk -CommonAccessIDStatus $Result # Below is a request that includes all optional parameters - # Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $Result + # Update-BetaCommonAccessStatusInBulk -CommonAccessIDStatus $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/BetaIAIRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md index 4421e5e3e096..84130b81255c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md @@ -75,10 +75,10 @@ $RecommendationRequestDto = @"{ try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto - Get-BetaRecommendations -BetaRecommendationRequestDto $Result + Get-BetaRecommendations -RecommendationRequestDto $Result # Below is a request that includes all optional parameters - # Get-BetaRecommendations -BetaRecommendationRequestDto $Result + # Get-BetaRecommendations -RecommendationRequestDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations" Write-Host $_.ErrorDetails @@ -167,10 +167,10 @@ $RecommendationConfigDto = @"{ try { $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto - Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $Result + Update-BetaRecommendationsConfig -RecommendationConfigDto $Result # Below is a request that includes all optional parameters - # Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $Result + # Update-BetaRecommendationsConfig -RecommendationConfigDto $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 f6d5fcc4efd0..8469a4058b0a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md @@ -95,7 +95,7 @@ try { New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -BetaRoleMiningPotentialRoleProvisionRequest $Result + # New-BetaPotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest" Write-Host $_.ErrorDetails @@ -169,10 +169,10 @@ $RoleMiningSessionDto = @"{ try { $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto - New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $Result + New-BetaRoleMiningSessions -RoleMiningSessionDto $Result # Below is a request that includes all optional parameters - # New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $Result + # New-BetaRoleMiningSessions -RoleMiningSessionDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions" Write-Host $_.ErrorDetails @@ -317,7 +317,7 @@ try { Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId # Below is a request that includes all optional parameters - # Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleExportRequest $Result + # Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleExportRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync" Write-Host $_.ErrorDetails @@ -1204,10 +1204,10 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potenti try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + # Update-BetaPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole" Write-Host $_.ErrorDetails @@ -1266,10 +1266,10 @@ $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potenti try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + # Update-BetaRoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -PatchPotentialRoleRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole" Write-Host $_.ErrorDetails @@ -1320,10 +1320,10 @@ $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining s try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaRoleMiningSession -SessionId $SessionId -BetaJsonPatchOperation $Result + Update-BetaRoleMiningSession -SessionId $SessionId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaRoleMiningSession -SessionId $SessionId -BetaJsonPatchOperation $Result + # Update-BetaRoleMiningSession -SessionId $SessionId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession" Write-Host $_.ErrorDetails @@ -1372,10 +1372,10 @@ $RoleMiningPotentialRoleEditEntitlements = @"{ try { $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements - Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result + Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleEditEntitlements $Result # Below is a request that includes all optional parameters - # Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result + # Update-BetaEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -RoleMiningPotentialRoleEditEntitlements $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/BetaIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md index c7d2a32102c8..ea75190b4fb4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md @@ -426,10 +426,10 @@ $SendAccountVerificationRequest = @"{ try { $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest - Send-BetaIdentityVerificationAccountToken -Id $Id -BetaSendAccountVerificationRequest $Result + Send-BetaIdentityVerificationAccountToken -Id $Id -SendAccountVerificationRequest $Result # Below is a request that includes all optional parameters - # Send-BetaIdentityVerificationAccountToken -Id $Id -BetaSendAccountVerificationRequest $Result + # Send-BetaIdentityVerificationAccountToken -Id $Id -SendAccountVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken" Write-Host $_.ErrorDetails @@ -481,10 +481,10 @@ $InviteIdentitiesRequest = @"{ try { $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest - Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $Result + Start-BetaIdentitiesInvite -InviteIdentitiesRequest $Result # Below is a request that includes all optional parameters - # Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $Result + # Start-BetaIdentitiesInvite -InviteIdentitiesRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite" Write-Host $_.ErrorDetails @@ -540,10 +540,10 @@ $ProcessIdentitiesRequest = @"{ try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest - Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $Result + Start-BetaIdentityProcessing -ProcessIdentitiesRequest $Result # Below is a request that includes all optional parameters - # Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $Result + # Start-BetaIdentityProcessing -ProcessIdentitiesRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing" 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 33d4b4cbbfb6..ee242a106296 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md @@ -82,10 +82,10 @@ $IdentityAttribute = @"{ try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - New-BetaIdentityAttribute -BetaIdentityAttribute $Result + New-BetaIdentityAttribute -IdentityAttribute $Result # Below is a request that includes all optional parameters - # New-BetaIdentityAttribute -BetaIdentityAttribute $Result + # New-BetaIdentityAttribute -IdentityAttribute $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute" Write-Host $_.ErrorDetails @@ -177,10 +177,10 @@ $IdentityAttributeNames = @"{ try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames - Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $Result + Remove-BetaIdentityAttributesInBulk -IdentityAttributeNames $Result # Below is a request that includes all optional parameters - # Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $Result + # Remove-BetaIdentityAttributesInBulk -IdentityAttributeNames $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk" Write-Host $_.ErrorDetails @@ -344,10 +344,10 @@ $IdentityAttribute = @"{ try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - Send-BetaIdentityAttribute -Name $Name -BetaIdentityAttribute $Result + Send-BetaIdentityAttribute -Name $Name -IdentityAttribute $Result # Below is a request that includes all optional parameters - # Send-BetaIdentityAttribute -Name $Name -BetaIdentityAttribute $Result + # Send-BetaIdentityAttribute -Name $Name -IdentityAttribute $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/BetaIdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md index 2fce374785a7..ff5322690ce2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md @@ -28,21 +28,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile -[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile +[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile +[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile [**Remove-BetaIdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles [**Export-BetaIdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles [**Get-BetaDefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Default identity attribute config -[**Get-BetaIdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile +[**Get-BetaIdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Gets a single Identity Profile [**Import-BetaIdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles -[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles +[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List [**Show-BetaGenerateIdentityPreview**](#show-generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview [**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 Identity Profile +[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile ## create-identity-profile -Create an 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) @@ -58,7 +59,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -201 | Created identity profile | IdentityProfile +201 | The created Identity Profile | IdentityProfile 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. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -121,14 +122,14 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create Identity Profile +# Create an Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-BetaIdentityProfile -BetaIdentityProfile $Result + New-BetaIdentityProfile -IdentityProfile $Result # Below is a request that includes all optional parameters - # New-BetaIdentityProfile -BetaIdentityProfile $Result + # New-BetaIdentityProfile -IdentityProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile" Write-Host $_.ErrorDetails @@ -137,16 +138,20 @@ try { [[Back to top]](#) ## delete-identity-profile -Delete an identity profile by ID. +This deletes an Identity Profile based on ID. + On success, this endpoint will return a reference to the bulk delete task result. + 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 ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | IdentityProfileId | **String** | True | The Identity Profile ID. ### Return type [**TaskResultSimplified**](../models/task-result-simplified) @@ -168,9 +173,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. -# Delete Identity Profile +# Delete an Identity Profile try { Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -340,7 +345,8 @@ try { [[Back to top]](#) ## get-identity-profile -Get a single identity profile by ID. +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) @@ -348,7 +354,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | IdentityProfileId | **String** | True | The Identity Profile ID ### Return type [**IdentityProfile**](../models/identity-profile) @@ -356,7 +362,7 @@ Path | IdentityProfileId | **String** | True | Identity profile ID. ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Identity profile object. | IdentityProfile +200 | An Identity Profile object | IdentityProfile 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. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -370,9 +376,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID -# Get Identity Profile +# Gets a single Identity Profile try { Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -483,10 +489,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $Result + Import-BetaIdentityProfiles -IdentityProfileExportedObject $Result # Below is a request that includes all optional parameters - # Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $Result + # Import-BetaIdentityProfiles -IdentityProfileExportedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles" Write-Host $_.ErrorDetails @@ -495,7 +501,7 @@ try { [[Back to top]](#) ## list-identity-profiles -Get a list of identity profiles, based on the specified query parameters. +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) @@ -506,7 +512,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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* + 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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* 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: **id, name, priority, created, modified, owner.id, owner.name** ### Return type @@ -515,7 +521,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of identity profiles. | IdentityProfile[] +200 | List of identityProfiles. | IdentityProfile[] 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. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -531,10 +537,10 @@ Code | Description | Data Type $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 8c190e6787aa4ed9a90bd9d5344523fb' # 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) +$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # 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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) $Sorters = "name,-priority" # 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, priority, created, modified, owner.id, owner.name** (optional) -# List Identity Profiles +# Identity Profiles List try { Get-BetaIdentityProfiles @@ -611,10 +617,10 @@ $IdentityPreviewRequest = @"{ try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $Result + Show-BetaGenerateIdentityPreview -IdentityPreviewRequest $Result # Below is a request that includes all optional parameters - # Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $Result + # Show-BetaGenerateIdentityPreview -IdentityPreviewRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview" Write-Host $_.ErrorDetails @@ -674,10 +680,13 @@ try { [[Back to top]](#) ## update-identity-profile -Update the specified identity profile with this PATCH request. +This updates the specified Identity Profile. + A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. -These fields cannot be updated: + +Some fields of the Schema cannot be updated. These fields are listed below: * id +* name * created * modified * identityCount @@ -689,8 +698,8 @@ These fields cannot be updated: ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | Identity profile ID. - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Path | IdentityProfileId | **String** | True | The Identity Profile ID + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -698,7 +707,7 @@ Path | IdentityProfileId | **String** | True | Identity profile ID. ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Updated identity profile. | IdentityProfile +200 | The updated Identity Profile. | IdentityProfile 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. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -712,22 +721,22 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" -}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update Identity Profile +# Update the Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result + Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result + # Update-BetaIdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $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 9b777ae064dd..ba99ba481668 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md @@ -74,10 +74,10 @@ $LauncherRequest = @"{ try { $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest - New-BetaLauncher -BetaLauncherRequest $Result + New-BetaLauncher -LauncherRequest $Result # Below is a request that includes all optional parameters - # New-BetaLauncher -BetaLauncherRequest $Result + # New-BetaLauncher -LauncherRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher" Write-Host $_.ErrorDetails @@ -275,10 +275,10 @@ $LauncherRequest = @"{ try { $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest - Send-BetaLauncher -LauncherID $LauncherID -BetaLauncherRequest $Result + Send-BetaLauncher -LauncherID $LauncherID -LauncherRequest $Result # Below is a request that includes all optional parameters - # Send-BetaLauncher -LauncherID $LauncherID -BetaLauncherRequest $Result + # Send-BetaLauncher -LauncherID $LauncherID -LauncherRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-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 98990938b90f..d86a4b1b9111 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md @@ -154,10 +154,10 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle Stat try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result + Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result + # Update-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $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 1bdc2b416f7f..f40fec6ce739 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md @@ -248,10 +248,10 @@ $MfaDuoConfig = @"{ try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-BetaMFADuoConfig -BetaMfaDuoConfig $Result + Set-BetaMFADuoConfig -MfaDuoConfig $Result # Below is a request that includes all optional parameters - # Set-BetaMFADuoConfig -BetaMfaDuoConfig $Result + # Set-BetaMFADuoConfig -MfaDuoConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig" Write-Host $_.ErrorDetails @@ -298,10 +298,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $Result + Set-BetaMFAKBAConfig -KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $Result + # Set-BetaMFAKBAConfig -KbaAnswerRequestItem $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig" Write-Host $_.ErrorDetails @@ -350,10 +350,10 @@ $MfaOktaConfig = @"{ try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-BetaMFAOktaConfig -BetaMfaOktaConfig $Result + Set-BetaMFAOktaConfig -MfaOktaConfig $Result # Below is a request that includes all optional parameters - # Set-BetaMFAOktaConfig -BetaMfaOktaConfig $Result + # Set-BetaMFAOktaConfig -MfaOktaConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig" 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 65ee4464a029..12046fb4ec6d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md @@ -63,10 +63,10 @@ $SendTokenRequest = @"{ try { $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest - New-BetaSendToken -BetaSendTokenRequest $Result + New-BetaSendToken -SendTokenRequest $Result # Below is a request that includes all optional parameters - # New-BetaSendToken -BetaSendTokenRequest $Result + # New-BetaSendToken -SendTokenRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken" Write-Host $_.ErrorDetails @@ -113,10 +113,10 @@ $VerificationPollRequest = @"{ try { $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest - Ping-BetaVerificationStatus -Method $Method -BetaVerificationPollRequest $Result + Ping-BetaVerificationStatus -Method $Method -VerificationPollRequest $Result # Below is a request that includes all optional parameters - # Ping-BetaVerificationStatus -Method $Method -BetaVerificationPollRequest $Result + # Ping-BetaVerificationStatus -Method $Method -VerificationPollRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus" Write-Host $_.ErrorDetails @@ -162,10 +162,10 @@ $DuoVerificationRequest = @"{ try { $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest - Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $Result + Send-BetaDuoVerifyRequest -DuoVerificationRequest $Result # Below is a request that includes all optional parameters - # Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $Result + # Send-BetaDuoVerifyRequest -DuoVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest" Write-Host $_.ErrorDetails @@ -212,10 +212,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $Result + Send-BetaKbaAnswers -KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $Result + # Send-BetaKbaAnswers -KbaAnswerRequestItem $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers" Write-Host $_.ErrorDetails @@ -260,10 +260,10 @@ $OktaVerificationRequest = @"{ try { $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest - Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $Result + Send-BetaOktaVerifyRequest -OktaVerificationRequest $Result # Below is a request that includes all optional parameters - # Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $Result + # Send-BetaOktaVerifyRequest -OktaVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest" Write-Host $_.ErrorDetails @@ -310,10 +310,10 @@ $TokenAuthRequest = @"{ try { $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest - Send-BetaTokenAuthRequest -BetaTokenAuthRequest $Result + Send-BetaTokenAuthRequest -TokenAuthRequest $Result # Below is a request that includes all optional parameters - # Send-BetaTokenAuthRequest -BetaTokenAuthRequest $Result + # Send-BetaTokenAuthRequest -TokenAuthRequest $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 0f4097b72873..707fcfb30db3 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md @@ -140,10 +140,10 @@ $ManagedClientStatus = @"{ try { $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus - Update-BetaManagedClientStatus -Id $Id -BetaManagedClientStatus $Result + Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result # Below is a request that includes all optional parameters - # Update-BetaManagedClientStatus -Id $Id -BetaManagedClientStatus $Result + # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $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 538a654a7b57..9b6ac162a3a5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md @@ -223,10 +223,10 @@ $ClientLogConfiguration = @"{ # Update managed cluster's log configuration try { - Send-BetaClientLogConfiguration -Id $Id -BetaClientLogConfiguration $Result + Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result # Below is a request that includes all optional parameters - # Send-BetaClientLogConfiguration -Id $Id -BetaClientLogConfiguration $Result + # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $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 9c6718dbdff1..b910329871fe 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md @@ -98,10 +98,10 @@ $MultiHostIntegrationsCreate = @"{ try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate - New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result + New-BetaMultiHostIntegration -MultiHostIntegrationsCreate $Result # Below is a request that includes all optional parameters - # New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result + # New-BetaMultiHostIntegration -MultiHostIntegrationsCreate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" Write-Host $_.ErrorDetails @@ -161,10 +161,10 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Hos try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources - New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -BetaMultiHostIntegrationsCreateSources $Result + New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result # Below is a request that includes all optional parameters - # New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -BetaMultiHostIntegrationsCreateSources $Result + # New-BetaSourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost" Write-Host $_.ErrorDetails @@ -713,10 +713,10 @@ $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. try { $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner - Update-BetaMultiHostSources -MultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result + Update-BetaMultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaMultiHostSources -MultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result + # Update-BetaMultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $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 7d88f301af1e..d4045321d210 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md @@ -121,10 +121,10 @@ $NonEmployeeApprovalDecision = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeApprovalDecision $Result + Approve-BetaNonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result # Below is a request that includes all optional parameters - # Approve-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeApprovalDecision $Result + # Approve-BetaNonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails @@ -182,10 +182,10 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $Result + New-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $Result + # New-BetaNonEmployeeRecord -NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails @@ -241,10 +241,10 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $Result + New-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $Result + # New-BetaNonEmployeeRequest -NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails @@ -253,7 +253,9 @@ try { [[Back to top]](#) ## create-non-employee-source -Create a 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) @@ -312,10 +314,10 @@ $NonEmployeeSourceRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $Result + New-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result # Below is a request that includes all optional parameters - # New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $Result + # New-BetaNonEmployeeSource -NonEmployeeSourceRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource" Write-Host $_.ErrorDetails @@ -367,10 +369,10 @@ $NonEmployeeSchemaAttributeBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result + New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result # Below is a request that includes all optional parameters - # New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result + # New-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails @@ -460,10 +462,10 @@ $DeleteNonEmployeeRecordInBulkRequest = @""@ try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest - Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $Result + Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $Result + # Remove-BetaNonEmployeeRecordInBulk -DeleteNonEmployeeRecordInBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk" Write-Host $_.ErrorDetails @@ -1375,20 +1377,18 @@ try { [[Back to top]](#) ## list-non-employee-sources -Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: - 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. - 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. +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 ------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. + Query | NonEmployeeCount | **Boolean** | True | The flag to determine whether return a non-employee count associate with source. 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 | RequestedFor | **String** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. - Query | NonEmployeeCount | **Boolean** | (optional) (default to $false) | Flag that determines whether the API will return a non-employee count associated with the source. 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: **name, created, sourceId** ### Return type @@ -1397,7 +1397,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of non-employee source objects. | NonEmployeeSourceWithNECount[] +200 | List of non-employee sources objects. | NonEmployeeSourceWithNECount[] 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. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -1410,20 +1410,20 @@ Code | Description | Data Type ### Example ```powershell +$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. +$NonEmployeeCount = $false # Boolean | The flag to determine whether return a non-employee count associate with 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) -$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) -$NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # 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, created, sourceId** (optional) # List Non-Employee Sources try { - Get-BetaNonEmployeeSources + Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $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 @@ -1474,10 +1474,10 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeRecord -Id $Id -BetaJsonPatchOperation $Result + Update-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeRecord -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaNonEmployeeRecord -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" Write-Host $_.ErrorDetails @@ -1531,10 +1531,10 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -BetaJsonPatchOperation $Result + Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -BetaJsonPatchOperation $Result + # Update-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails @@ -1584,10 +1584,10 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeSource -SourceId $SourceId -BetaJsonPatchOperation $Result + Update-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeSource -SourceId $SourceId -BetaJsonPatchOperation $Result + # Update-BetaNonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource" Write-Host $_.ErrorDetails @@ -1634,10 +1634,10 @@ $NonEmployeeRejectApprovalDecision = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeRejectApprovalDecision $Result + Deny-BetaNonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result # Below is a request that includes all optional parameters - # Deny-BetaNonEmployeeRequest -Id $Id -BetaNonEmployeeRejectApprovalDecision $Result + # Deny-BetaNonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest" Write-Host $_.ErrorDetails @@ -1696,10 +1696,10 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-BetaNonEmployeeRecord -Id $Id -BetaNonEmployeeRequestBody $Result + Update-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeRecord -Id $Id -BetaNonEmployeeRequestBody $Result + # Update-BetaNonEmployeeRecord -Id $Id -NonEmployeeRequestBody $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 4e79b0af0305..0bc2893bcc69 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md @@ -72,10 +72,10 @@ $DomainAddress = @"{ try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress - New-BetaDomainDkim -BetaDomainAddress $Result + New-BetaDomainDkim -DomainAddress $Result # Below is a request that includes all optional parameters - # New-BetaDomainDkim -BetaDomainAddress $Result + # New-BetaDomainDkim -DomainAddress $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim" Write-Host $_.ErrorDetails @@ -137,10 +137,10 @@ $TemplateDto = @"{ try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto - New-BetaNotificationTemplate -BetaTemplateDto $Result + New-BetaNotificationTemplate -TemplateDto $Result # Below is a request that includes all optional parameters - # New-BetaNotificationTemplate -BetaTemplateDto $Result + # New-BetaNotificationTemplate -TemplateDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate" Write-Host $_.ErrorDetails @@ -188,10 +188,10 @@ $EmailStatusDto = @"{ try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto - New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result + New-BetaVerifiedFromAddress -EmailStatusDto $Result # Below is a request that includes all optional parameters - # New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result + # New-BetaVerifiedFromAddress -EmailStatusDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress" Write-Host $_.ErrorDetails @@ -239,10 +239,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto - Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $Result + Remove-BetaNotificationTemplatesInBulk -TemplateBulkDeleteDto $Result # Below is a request that includes all optional parameters - # Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $Result + # Remove-BetaNotificationTemplatesInBulk -TemplateBulkDeleteDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk" Write-Host $_.ErrorDetails @@ -707,10 +707,10 @@ $MailFromAttributesDto = @"{ try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto - Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result + Send-BetaMailFromAttributes -MailFromAttributesDto $Result # Below is a request that includes all optional parameters - # Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result + # Send-BetaMailFromAttributes -MailFromAttributesDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes" Write-Host $_.ErrorDetails @@ -758,10 +758,10 @@ $SendTestNotificationRequestDto = @"{ try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto - Send-BetaTestNotification -BetaSendTestNotificationRequestDto $Result + Send-BetaTestNotification -SendTestNotificationRequestDto $Result # Below is a request that includes all optional parameters - # Send-BetaTestNotification -BetaSendTestNotificationRequestDto $Result + # Send-BetaTestNotification -SendTestNotificationRequestDto $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 1a99d5a35c5e..d63a85859d05 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md @@ -78,10 +78,10 @@ $CreateOAuthClientRequest = @"{ try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-BetaOauthClient -BetaCreateOAuthClientRequest $Result + New-BetaOauthClient -CreateOAuthClientRequest $Result # Below is a request that includes all optional parameters - # New-BetaOauthClient -BetaCreateOAuthClientRequest $Result + # New-BetaOauthClient -CreateOAuthClientRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient" Write-Host $_.ErrorDetails @@ -271,10 +271,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaOauthClient -Id $Id -BetaJsonPatchOperation $Result + Update-BetaOauthClient -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaOauthClient -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaOauthClient -Id $Id -JsonPatchOperation $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 017692b629c7..8aced624d7c4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md @@ -152,10 +152,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaOrgConfig -BetaJsonPatchOperation $Result + Update-BetaOrgConfig -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaOrgConfig -BetaJsonPatchOperation $Result + # Update-BetaOrgConfig -JsonPatchOperation $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 9ebbaa86177f..91d3f25ad4b9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md @@ -70,10 +70,10 @@ $PasswordOrgConfig = @"{ try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-BetaPasswordOrgConfig -BetaPasswordOrgConfig $Result + New-BetaPasswordOrgConfig -PasswordOrgConfig $Result # Below is a request that includes all optional parameters - # New-BetaPasswordOrgConfig -BetaPasswordOrgConfig $Result + # New-BetaPasswordOrgConfig -PasswordOrgConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordOrgConfig" Write-Host $_.ErrorDetails @@ -166,10 +166,10 @@ $PasswordOrgConfig = @"{ try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-BetaPasswordOrgConfig -BetaPasswordOrgConfig $Result + Send-BetaPasswordOrgConfig -PasswordOrgConfig $Result # Below is a request that includes all optional parameters - # Send-BetaPasswordOrgConfig -BetaPasswordOrgConfig $Result + # Send-BetaPasswordOrgConfig -PasswordOrgConfig $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/BetaPasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md index a748721d9bc1..821695345f3a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md @@ -86,10 +86,10 @@ $PasswordDigitTokenReset = @"{ try { $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset - New-BetaDigitToken -BetaPasswordDigitTokenReset $Result + New-BetaDigitToken -PasswordDigitTokenReset $Result # Below is a request that includes all optional parameters - # New-BetaDigitToken -BetaPasswordDigitTokenReset $Result + # New-BetaDigitToken -PasswordDigitTokenReset $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken" Write-Host $_.ErrorDetails @@ -188,10 +188,10 @@ $PasswordInfoQueryDTO = @"{ try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $Result + Search-BetaPasswordInfo -PasswordInfoQueryDTO $Result # Below is a request that includes all optional parameters - # Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $Result + # Search-BetaPasswordInfo -PasswordInfoQueryDTO $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo" Write-Host $_.ErrorDetails @@ -283,10 +283,10 @@ $PasswordChangeRequest = @"{ try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-BetaIdentityPassword -BetaPasswordChangeRequest $Result + Set-BetaIdentityPassword -PasswordChangeRequest $Result # Below is a request that includes all optional parameters - # Set-BetaIdentityPassword -BetaPasswordChangeRequest $Result + # Set-BetaIdentityPassword -PasswordChangeRequest $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 b20a0fbe577b..da0512a422e8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md @@ -101,10 +101,10 @@ $PasswordPolicyV3Dto = @"{ try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $Result + New-BetaPasswordPolicy -PasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters - # New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $Result + # New-BetaPasswordPolicy -PasswordPolicyV3Dto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy" Write-Host $_.ErrorDetails @@ -324,10 +324,10 @@ $PasswordPolicyV3Dto = @"{ try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-BetaPasswordPolicy -Id $Id -BetaPasswordPolicyV3Dto $Result + Set-BetaPasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters - # Set-BetaPasswordPolicy -Id $Id -BetaPasswordPolicyV3Dto $Result + # Set-BetaPasswordPolicy -Id $Id -PasswordPolicyV3Dto $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 46dd95e53ac0..91f89a82ec94 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md @@ -98,10 +98,10 @@ $PasswordSyncGroup = @"{ try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $Result + New-BetaPasswordSyncGroup -PasswordSyncGroup $Result # Below is a request that includes all optional parameters - # New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $Result + # New-BetaPasswordSyncGroup -PasswordSyncGroup $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails @@ -294,10 +294,10 @@ $PasswordSyncGroup = @"{ try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-BetaPasswordSyncGroup -Id $Id -BetaPasswordSyncGroup $Result + Update-BetaPasswordSyncGroup -Id $Id -PasswordSyncGroup $Result # Below is a request that includes all optional parameters - # Update-BetaPasswordSyncGroup -Id $Id -BetaPasswordSyncGroup $Result + # Update-BetaPasswordSyncGroup -Id $Id -PasswordSyncGroup $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 518c159b993e..bf25408b1e69 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md @@ -73,10 +73,10 @@ $CreatePersonalAccessTokenRequest = @"{ try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $Result + New-BetaPersonalAccessToken -CreatePersonalAccessTokenRequest $Result # Below is a request that includes all optional parameters - # New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $Result + # New-BetaPersonalAccessToken -CreatePersonalAccessTokenRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken" Write-Host $_.ErrorDetails @@ -220,10 +220,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaPersonalAccessToken -Id $Id -BetaJsonPatchOperation $Result + Update-BetaPersonalAccessToken -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaPersonalAccessToken -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaPersonalAccessToken -Id $Id -JsonPatchOperation $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 b16b1969bbfc..3999de6e90c0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md @@ -123,10 +123,10 @@ $PublicIdentityConfig = @"{ try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $Result + Update-BetaPublicIdentityConfig -PublicIdentityConfig $Result # Below is a request that includes all optional parameters - # Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $Result + # Update-BetaPublicIdentityConfig -PublicIdentityConfig $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/BetaRolesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md index 6610556c20b9..9c084863bc34 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md @@ -262,10 +262,10 @@ $Role = @"{ try { $Result = ConvertFrom-JsonToRole -Json $Role - New-BetaRole -BetaRole $Result + New-BetaRole -Role $Result # Below is a request that includes all optional parameters - # New-BetaRole -BetaRole $Result + # New-BetaRole -Role $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole" Write-Host $_.ErrorDetails @@ -313,10 +313,10 @@ $RoleBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $Result + Remove-BetaBulkRoles -RoleBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $Result + # Remove-BetaBulkRoles -RoleBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles" Write-Host $_.ErrorDetails @@ -652,10 +652,10 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaRole -Id $Id -BetaJsonPatchOperation $Result + Update-BetaRole -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaRole -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaRole -Id $Id -JsonPatchOperation $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 f1a30a033dcd..a00734bc59f4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md @@ -86,10 +86,10 @@ $SimIntegrationDetails = @"{ try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-BetaSIMIntegration -BetaSimIntegrationDetails $Result + New-BetaSIMIntegration -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # New-BetaSIMIntegration -BetaSimIntegrationDetails $Result + # New-BetaSIMIntegration -SimIntegrationDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" Write-Host $_.ErrorDetails @@ -271,10 +271,10 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\" try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result + Update-BetaBeforeProvisioningRule -Id $Id -JsonPatch $Result # Below is a request that includes all optional parameters - # Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result + # Update-BetaBeforeProvisioningRule -Id $Id -JsonPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" Write-Host $_.ErrorDetails @@ -320,10 +320,10 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\" try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result + Update-BetaSIMAttributes -Id $Id -JsonPatch $Result # Below is a request that includes all optional parameters - # Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result + # Update-BetaSIMAttributes -Id $Id -JsonPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" Write-Host $_.ErrorDetails @@ -386,10 +386,10 @@ $SimIntegrationDetails = @"{ try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result + Send-BetaSIMIntegration -Id $Id -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result + # Send-BetaSIMIntegration -Id $Id -SimIntegrationDetails $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 c85ae9a537b5..a0c7cf7b9417 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md @@ -155,10 +155,10 @@ $SodPolicy = @"{ try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-BetaSodPolicy -BetaSodPolicy $Result + New-BetaSodPolicy -SodPolicy $Result # Below is a request that includes all optional parameters - # New-BetaSodPolicy -BetaSodPolicy $Result + # New-BetaSodPolicy -SodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" Write-Host $_.ErrorDetails @@ -855,10 +855,10 @@ $SodPolicySchedule = @"{ try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result + Send-BetaPolicySchedule -Id $Id -SodPolicySchedule $Result # Below is a request that includes all optional parameters - # Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result + # Send-BetaPolicySchedule -Id $Id -SodPolicySchedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" Write-Host $_.ErrorDetails @@ -963,10 +963,10 @@ $SodPolicy = @"{ try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result + Send-BetaSodPolicy -Id $Id -SodPolicy $Result # Below is a request that includes all optional parameters - # Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result + # Send-BetaSodPolicy -Id $Id -SodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" Write-Host $_.ErrorDetails @@ -1017,7 +1017,7 @@ try { Start-BetaSodAllPoliciesForOrg # Below is a request that includes all optional parameters - # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $Result + # Start-BetaSodAllPoliciesForOrg -MultiPolicyRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" 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 bdcc9f0b0629..0ba2d25d998a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md @@ -90,10 +90,10 @@ $IdentityWithNewAccess = @"{ try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result + Start-BetaPredictSodViolations -IdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result + # Start-BetaPredictSodViolations -IdentityWithNewAccess $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 3642036b38c9..002fd60c0e46 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md @@ -65,10 +65,10 @@ $ExportPayload = @"{ try { $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-BetaSpConfig -BetaExportPayload $Result + Export-BetaSpConfig -ExportPayload $Result # Below is a request that includes all optional parameters - # Export-BetaSpConfig -BetaExportPayload $Result + # Export-BetaSpConfig -ExportPayload $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" Write-Host $_.ErrorDetails @@ -319,7 +319,7 @@ try { Import-BetaSpConfig -Data $Data # Below is a request that includes all optional parameters - # Import-BetaSpConfig -Data $Data -Preview $Preview -BetaOptions $Options + # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md index 2c90a01852dc..cc67b93d79ea 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md @@ -86,10 +86,10 @@ $SearchAttributeConfig = @"{ try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result + New-BetaSearchAttributeConfig -SearchAttributeConfig $Result # Below is a request that includes all optional parameters - # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result + # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails @@ -276,10 +276,10 @@ $Name = "promotedMailAttribute" # String | Name of the extended search attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result + Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result + # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $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 f6a415b298e2..9ad073b45824 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md @@ -101,10 +101,10 @@ $Segment = @"{ try { $Result = ConvertFrom-JsonToSegment -Json $Segment - New-BetaSegment -BetaSegment $Result + New-BetaSegment -Segment $Result # Below is a request that includes all optional parameters - # New-BetaSegment -BetaSegment $Result + # New-BetaSegment -Segment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-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 86a4ab831a78..7ee4a0f569ad 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md @@ -119,10 +119,10 @@ $ServiceDeskIntegrationDto = @"{ try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result + New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result + # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails @@ -448,10 +448,10 @@ $PatchServiceDeskIntegrationRequest = @""@ try { $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result + Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result + # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails @@ -527,10 +527,10 @@ $ServiceDeskIntegrationDto = @"{ try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result + Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result + # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails @@ -577,10 +577,10 @@ $QueuedCheckConfigDetails = @"{ try { $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result + Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result # Below is a request that includes all optional parameters - # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result + # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $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/BetaSourcesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md index a633da212550..7c00d966d422 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md @@ -198,10 +198,10 @@ $ProvisioningPolicyDto = @"{ try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-BetaProvisioningPolicy -SourceId $SourceId -BetaProvisioningPolicyDto $Result + New-BetaProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # New-BetaProvisioningPolicy -SourceId $SourceId -BetaProvisioningPolicyDto $Result + # New-BetaProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaProvisioningPolicy" Write-Host $_.ErrorDetails @@ -329,10 +329,10 @@ $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures try { $Result = ConvertFrom-JsonToSource -Json $Source - New-BetaSource -BetaSource $Result + New-BetaSource -Source $Result # Below is a request that includes all optional parameters - # New-BetaSource -BetaSource $Result -ProvisionAsCsv $ProvisionAsCsv + # New-BetaSource -Source $Result -ProvisionAsCsv $ProvisionAsCsv } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSource" Write-Host $_.ErrorDetails @@ -410,10 +410,10 @@ $Schema = @"{ try { $Result = ConvertFrom-JsonToSchema -Json $Schema - New-BetaSourceSchema -SourceId $SourceId -BetaSchema $Result + New-BetaSourceSchema -SourceId $SourceId -Schema $Result # Below is a request that includes all optional parameters - # New-BetaSourceSchema -SourceId $SourceId -BetaSchema $Result + # New-BetaSourceSchema -SourceId $SourceId -Schema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceSchema" Write-Host $_.ErrorDetails @@ -1631,10 +1631,10 @@ $ResourceObjectsRequest = @"{ try { $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest - Receive-BetaResourceObjects -SourceId $SourceId -BetaResourceObjectsRequest $Result + Receive-BetaResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result # Below is a request that includes all optional parameters - # Receive-BetaResourceObjects -SourceId $SourceId -BetaResourceObjectsRequest $Result + # Receive-BetaResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-BetaResourceObjects" Write-Host $_.ErrorDetails @@ -1747,10 +1747,10 @@ $CorrelationConfig = @"{ try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig - Send-BetaCorrelationConfig -SourceId $SourceId -BetaCorrelationConfig $Result + Send-BetaCorrelationConfig -SourceId $SourceId -CorrelationConfig $Result # Below is a request that includes all optional parameters - # Send-BetaCorrelationConfig -SourceId $SourceId -BetaCorrelationConfig $Result + # Send-BetaCorrelationConfig -SourceId $SourceId -CorrelationConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaCorrelationConfig" Write-Host $_.ErrorDetails @@ -1805,10 +1805,10 @@ $NativeChangeDetectionConfig = @"{ try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig - Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -BetaNativeChangeDetectionConfig $Result + Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -NativeChangeDetectionConfig $Result # Below is a request that includes all optional parameters - # Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -BetaNativeChangeDetectionConfig $Result + # Send-BetaNativeChangeDetectionConfig -SourceId $SourceId -NativeChangeDetectionConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNativeChangeDetectionConfig" Write-Host $_.ErrorDetails @@ -1897,10 +1897,10 @@ $ProvisioningPolicyDto = @"{ try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -BetaProvisioningPolicyDto $Result + Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -BetaProvisioningPolicyDto $Result + # Send-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaProvisioningPolicy" Write-Host $_.ErrorDetails @@ -2042,10 +2042,10 @@ $Source = @"{ try { $Result = ConvertFrom-JsonToSource -Json $Source - Send-BetaSource -Id $Id -BetaSource $Result + Send-BetaSource -Id $Id -Source $Result # Below is a request that includes all optional parameters - # Send-BetaSource -Id $Id -BetaSource $Result + # Send-BetaSource -Id $Id -Source $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSource" Write-Host $_.ErrorDetails @@ -2110,10 +2110,10 @@ $AttrSyncSourceConfig = @"{ try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig - Send-BetaSourceAttrSyncConfig -Id $Id -BetaAttrSyncSourceConfig $Result + Send-BetaSourceAttrSyncConfig -Id $Id -AttrSyncSourceConfig $Result # Below is a request that includes all optional parameters - # Send-BetaSourceAttrSyncConfig -Id $Id -BetaAttrSyncSourceConfig $Result + # Send-BetaSourceAttrSyncConfig -Id $Id -AttrSyncSourceConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceAttrSyncConfig" Write-Host $_.ErrorDetails @@ -2199,10 +2199,10 @@ $Schema = @"{ try { $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -BetaSchema $Result + Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result # Below is a request that includes all optional parameters - # Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -BetaSchema $Result + # Send-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceSchema" Write-Host $_.ErrorDetails @@ -2429,10 +2429,10 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -BetaProvisioningPolicyDto $Result + Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -BetaProvisioningPolicyDto $Result + # Update-BetaProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPoliciesInBulk" Write-Host $_.ErrorDetails @@ -2487,10 +2487,10 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -BetaJsonPatchOperation $Result + Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -BetaJsonPatchOperation $Result + # Update-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPolicy" Write-Host $_.ErrorDetails @@ -2557,10 +2557,10 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSource -Id $Id -BetaJsonPatchOperation $Result + Update-BetaSource -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaSource -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaSource -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSource" Write-Host $_.ErrorDetails @@ -2623,10 +2623,10 @@ $SourceEntitlementRequestConfig = @"{ try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -BetaSourceEntitlementRequestConfig $Result + Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -SourceEntitlementRequestConfig $Result # Below is a request that includes all optional parameters - # Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -BetaSourceEntitlementRequestConfig $Result + # Update-BetaSourceEntitlementRequestConfig -SourceId $SourceId -SourceEntitlementRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceEntitlementRequestConfig" Write-Host $_.ErrorDetails @@ -2708,10 +2708,10 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -BetaJsonPatchOperation $Result + Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -BetaJsonPatchOperation $Result + # Update-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $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 8687ba1d6c94..3525aeec85b9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md @@ -239,10 +239,10 @@ $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-BetaSed -Id $Id -BetaSedPatch $Result + Update-BetaSed -Id $Id -SedPatch $Result # Below is a request that includes all optional parameters - # Update-BetaSed -Id $Id -BetaSedPatch $Result + # Update-BetaSed -Id $Id -SedPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed" Write-Host $_.ErrorDetails @@ -290,10 +290,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-BetaSedApproval -BetaSedApproval $Result + Submit-BetaSedApproval -SedApproval $Result # Below is a request that includes all optional parameters - # Submit-BetaSedApproval -BetaSedApproval $Result + # Submit-BetaSedApproval -SedApproval $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval" Write-Host $_.ErrorDetails @@ -344,10 +344,10 @@ $SedAssignment = @"{ try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-BetaSedAssignment -BetaSedAssignment $Result + Submit-BetaSedAssignment -SedAssignment $Result # Below is a request that includes all optional parameters - # Submit-BetaSedAssignment -BetaSedAssignment $Result + # Submit-BetaSedAssignment -SedAssignment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment" Write-Host $_.ErrorDetails @@ -400,7 +400,7 @@ try { Submit-BetaSedBatchRequest # Below is a request that includes all optional parameters - # Submit-BetaSedBatchRequest -BetaSedBatchRequest $Result + # Submit-BetaSedBatchRequest -SedBatchRequest $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 2edb76507a13..97391716d646 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md @@ -176,10 +176,10 @@ $BulkTaggedObject = @"{ try { $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject - Remove-BetaTagsToManyObject -BetaBulkTaggedObject $Result + Remove-BetaTagsToManyObject -BulkTaggedObject $Result # Below is a request that includes all optional parameters - # Remove-BetaTagsToManyObject -BetaBulkTaggedObject $Result + # Remove-BetaTagsToManyObject -BulkTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject" Write-Host $_.ErrorDetails @@ -388,10 +388,10 @@ $TaggedObject = @"{ try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-BetaTaggedObject -Type $Type -Id $Id -BetaTaggedObject $Result + Send-BetaTaggedObject -Type $Type -Id $Id -TaggedObject $Result # Below is a request that includes all optional parameters - # Send-BetaTaggedObject -Type $Type -Id $Id -BetaTaggedObject $Result + # Send-BetaTaggedObject -Type $Type -Id $Id -TaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject" Write-Host $_.ErrorDetails @@ -443,10 +443,10 @@ $TaggedObject = @"{ try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-BetaTagToObject -BetaTaggedObject $Result + Set-BetaTagToObject -TaggedObject $Result # Below is a request that includes all optional parameters - # Set-BetaTagToObject -BetaTaggedObject $Result + # Set-BetaTagToObject -TaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject" Write-Host $_.ErrorDetails @@ -503,10 +503,10 @@ $BulkTaggedObject = @"{ try { $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject - Set-BetaTagsToManyObjects -BetaBulkTaggedObject $Result + Set-BetaTagsToManyObjects -BulkTaggedObject $Result # Below is a request that includes all optional parameters - # Set-BetaTagsToManyObjects -BetaBulkTaggedObject $Result + # Set-BetaTagsToManyObjects -BulkTaggedObject $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 91fd3c73c811..556c7178c517 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md @@ -74,10 +74,10 @@ $Tag = @"{ try { $Result = ConvertFrom-JsonToTag -Json $Tag - New-BetaTag -BetaTag $Result + New-BetaTag -Tag $Result # Below is a request that includes all optional parameters - # New-BetaTag -BetaTag $Result + # New-BetaTag -Tag $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag" 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 b9df756c8b2e..900b1ad83c4b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md @@ -268,10 +268,10 @@ $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaTaskStatus -Id $Id -BetaJsonPatchOperation $Result + Update-BetaTaskStatus -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaTaskStatus -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaTaskStatus -Id $Id -JsonPatchOperation $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/BetaTransformsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md index 7f2e0476a6f6..de74a0251293 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md @@ -80,10 +80,10 @@ $Transform = @"{ try { $Result = ConvertFrom-JsonToTransform -Json $Transform - New-BetaTransform -BetaTransform $Result + New-BetaTransform -Transform $Result # Below is a request that includes all optional parameters - # New-BetaTransform -BetaTransform $Result + # New-BetaTransform -Transform $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform" Write-Host $_.ErrorDetails @@ -301,7 +301,7 @@ try { Update-BetaTransform -Id $Id # Below is a request that includes all optional parameters - # Update-BetaTransform -Id $Id -BetaTransform $Result + # Update-BetaTransform -Id $Id -Transform $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 ede7f30e4355..05136ae275ee 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md @@ -113,10 +113,10 @@ $CompleteInvocation = @"{ try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation - Complete-BetaTriggerInvocation -Id $Id -BetaCompleteInvocation $Result + Complete-BetaTriggerInvocation -Id $Id -CompleteInvocation $Result # Below is a request that includes all optional parameters - # Complete-BetaTriggerInvocation -Id $Id -BetaCompleteInvocation $Result + # Complete-BetaTriggerInvocation -Id $Id -CompleteInvocation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation" Write-Host $_.ErrorDetails @@ -185,10 +185,10 @@ $SubscriptionPostRequest = @"{ try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest - New-BetaSubscription -BetaSubscriptionPostRequest $Result + New-BetaSubscription -SubscriptionPostRequest $Result # Below is a request that includes all optional parameters - # New-BetaSubscription -BetaSubscriptionPostRequest $Result + # New-BetaSubscription -SubscriptionPostRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription" Write-Host $_.ErrorDetails @@ -444,10 +444,10 @@ $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription t try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner - Update-BetaSubscription -Id $Id -BetaSubscriptionPatchRequestInner $Result + Update-BetaSubscription -Id $Id -SubscriptionPatchRequestInner $Result # Below is a request that includes all optional parameters - # Update-BetaSubscription -Id $Id -BetaSubscriptionPatchRequestInner $Result + # Update-BetaSubscription -Id $Id -SubscriptionPatchRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" Write-Host $_.ErrorDetails @@ -500,10 +500,10 @@ $TestInvocation = @"{ try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation - Start-BetaTestTriggerInvocation -BetaTestInvocation $Result + Start-BetaTestTriggerInvocation -TestInvocation $Result # Below is a request that includes all optional parameters - # Start-BetaTestTriggerInvocation -BetaTestInvocation $Result + # Start-BetaTestTriggerInvocation -TestInvocation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation" Write-Host $_.ErrorDetails @@ -552,10 +552,10 @@ $ValidateFilterInputDto = @"{ try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto - Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $Result + Test-BetaSubscriptionFilter -ValidateFilterInputDto $Result # Below is a request that includes all optional parameters - # Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $Result + # Test-BetaSubscriptionFilter -ValidateFilterInputDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter" Write-Host $_.ErrorDetails @@ -633,10 +633,10 @@ $SubscriptionPutRequest = @"{ try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest - Update-BetaSubscription -Id $Id -BetaSubscriptionPutRequest $Result + Update-BetaSubscription -Id $Id -SubscriptionPutRequest $Result # Below is a request that includes all optional parameters - # Update-BetaSubscription -Id $Id -BetaSubscriptionPutRequest $Result + # Update-BetaSubscription -Id $Id -SubscriptionPutRequest $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 0ac123a3db04..78bed8504c9c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md @@ -108,10 +108,10 @@ $TenantUiMetadataItemUpdateRequest = @"{ try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest - Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $Result + Set-BetaTenantUiMetadata -TenantUiMetadataItemUpdateRequest $Result # Below is a request that includes all optional parameters - # Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $Result + # Set-BetaTenantUiMetadata -TenantUiMetadataItemUpdateRequest $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 1a8c197851b3..529c2e592634 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md @@ -85,10 +85,10 @@ $VendorConnectorMapping = @"{ try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-BetaVendorConnectorMapping -BetaVendorConnectorMapping $Result + New-BetaVendorConnectorMapping -VendorConnectorMapping $Result # Below is a request that includes all optional parameters - # New-BetaVendorConnectorMapping -BetaVendorConnectorMapping $Result + # New-BetaVendorConnectorMapping -VendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVendorConnectorMapping" Write-Host $_.ErrorDetails @@ -155,10 +155,10 @@ $VendorConnectorMapping = @"{ try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-BetaVendorConnectorMapping -BetaVendorConnectorMapping $Result + Remove-BetaVendorConnectorMapping -VendorConnectorMapping $Result # Below is a request that includes all optional parameters - # Remove-BetaVendorConnectorMapping -BetaVendorConnectorMapping $Result + # Remove-BetaVendorConnectorMapping -VendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVendorConnectorMapping" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md index 4202b153aa41..84abcff228a1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md @@ -218,10 +218,10 @@ $WorkItemForward = @"{ try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result + Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result # Below is a request that includes all optional parameters - # Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result + # Invoke-BetaForwardWorkItem -Id $Id -WorkItemForward $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" 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 85e5aabe147e..875890364e29 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md @@ -79,10 +79,10 @@ $ConfigurationItemRequest = @"{ try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result + New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result + # New-BetaReassignmentConfiguration -ConfigurationItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails @@ -408,10 +408,10 @@ $ConfigurationItemRequest = @"{ try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result + Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result + # Send-BetaReassignmentConfig -IdentityId $IdentityId -ConfigurationItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" Write-Host $_.ErrorDetails @@ -458,10 +458,10 @@ $TenantConfigurationRequest = @"{ try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result + Send-BetaTenantConfiguration -TenantConfigurationRequest $Result # Below is a request that includes all optional parameters - # Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result + # Send-BetaTenantConfiguration -TenantConfigurationRequest $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 5d2dda2ceb06..513b9b8bb36a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md @@ -119,10 +119,10 @@ $CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568 try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-BetaWorkflow -BetaCreateWorkflowRequest $Result + New-BetaWorkflow -CreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # New-BetaWorkflow -BetaCreateWorkflowRequest $Result + # New-BetaWorkflow -CreateWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" Write-Host $_.ErrorDetails @@ -649,10 +649,10 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result + Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result + # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" Write-Host $_.ErrorDetails @@ -699,7 +699,7 @@ try { Submit-BetaExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Submit-BetaExternalExecuteWorkflow -Id $Id -BetaPostExternalExecuteWorkflowRequest $Result + # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails @@ -791,7 +791,7 @@ try { Test-BetaExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -Id $Id -BetaTestExternalExecuteWorkflowRequest $Result + # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails @@ -838,10 +838,10 @@ $TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b, try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result + Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result + # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" Write-Host $_.ErrorDetails @@ -923,10 +923,10 @@ $WorkflowBody = @"{ try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result + Update-BetaWorkflow -Id $Id -WorkflowBody $Result # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result + # Update-BetaWorkflow -Id $Id -WorkflowBody $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/Models/AccessCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessCriteria.md index b61f64ef834b..41f243a75e61 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessCriteria.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessCriteria.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $AccessCriteria = Initialize-PSSailpoint.BetaAccessCriteria -Name money-in ` - -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] + -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileUpdateItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileUpdateItem.md index 45ca571691cf..aa0c7ea60772 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileUpdateItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileUpdateItem.md @@ -29,9 +29,9 @@ $AccessProfileUpdateItem = Initialize-PSSailpoint.BetaAccessProfileUpdateItem - -Requestable false ` -Status 201 ` -Description -> Access profile is updated successfully. +> Access profile is updated successfully. -> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found. +> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found. ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md index e469617432b0..b8a9416bbe4b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $AccessRequest = Initialize-PSSailpoint.BetaAccessRequest -RequestedFor null ` -RequestType null ` -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md index 07bc9eca535f..16415ee28f6a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $AccessRequestItem = Initialize-PSSailpoint.BetaAccessRequestItem -Type ACCESS_PROFILE ` -Id 2c9180835d2e5168015d32f890ca1581 ` -Comment Requesting access profile for John Doe ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -RemoveDate 2020-07-11T21:23:15Z ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItemResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItemResponse.md index acd3b35571fe..b13edfcd4654 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItemResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItemResponse.md @@ -36,7 +36,7 @@ $AccessRequestItemResponse = Initialize-PSSailpoint.BetaAccessRequestItemRespons -Description The role descrition ` -SourceId 8a80828f643d484f01643e14202e206f ` -SourceName Source1 ` - -ApprovalInfos [{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}] + -ApprovalInfos [{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md index 20b8ba247485..06724e3792c9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md @@ -35,7 +35,7 @@ $AccessRequestPostApprovalRequestedItemsStatusInner = Initialize-PSSailpoint.Bet -Type ACCESS_PROFILE ` -Operation Add ` -Comment William needs this access to do his job. ` - -ClientMetadata {applicationName=My application} ` + -ClientMetadata {applicationName=My application} ` -ApprovalInfo null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md index 4de59097e41c..527fcb7c8c53 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestRecommendationItemDetail.md @@ -34,7 +34,7 @@ $AccessRequestRecommendationItemDetail = Initialize-PSSailpoint.BetaAccessReques -Requested true ` -Viewed true ` -Messages null ` - -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] + -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestResponse.md index be2ccaaaf399..483247dd48a9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestResponse.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccessRequestResponse = Initialize-PSSailpoint.BetaAccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] ` - -ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] +$AccessRequestResponse = Initialize-PSSailpoint.BetaAccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] ` + -ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestResponse1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestResponse1.md index 0e0696015ffc..af8809e2fcfd 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestResponse1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestResponse1.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $AccessRequestResponse1 = Initialize-PSSailpoint.BetaAccessRequestResponse1 -RequesterId 2c91808a77ff216301782327a50f09bf ` -RequesterName Bing C ` - -Items [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}] + -Items [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestTracking.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestTracking.md index 5f7e1a71a708..1674a77ccda5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestTracking.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestTracking.md @@ -27,8 +27,8 @@ Name | Type | Description | Notes ```powershell $AccessRequestTracking = Initialize-PSSailpoint.BetaAccessRequestTracking -RequestedFor 2c918084660f45d6016617daa9210584 ` -RequestedItemsDetails { -"type": "ENTITLEMENT", -"id": "779c6fd7171540bba1184e5946112c28" +"type": "ENTITLEMENT", +"id": "779c6fd7171540bba1184e5946112c28" } ` -AttributesHash -1928438224 ` -AccessRequestIds [5d3118c518a44ec7805450d53479ccdb] diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Account.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Account.md index 8b111ed132d2..18ab680893d3 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Account.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Account.md @@ -61,7 +61,7 @@ $Account = Initialize-PSSailpoint.BetaAccount -Id id12345 ` -ConnectionType direct ` -IsMachine true ` -Recommendation null ` - -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` + -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` -Authoritative false ` -Description null ` -Disabled false ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountActivityItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountActivityItem.md index bb66461ceae2..dae1241c371e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountActivityItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountActivityItem.md @@ -51,7 +51,7 @@ $AccountActivityItem = Initialize-PSSailpoint.BetaAccountActivityItem -Id 48c54 -NativeIdentity Sandie.Camero ` -SourceId 2c91808363ef85290164000587130c0c ` -AccountRequestInfo null ` - -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ` + -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ` -RemoveDate 2020-07-11T00:00Z ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttribute.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttribute.md index b86f14fcf75c..835ddf49edf1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttribute.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttribute.md @@ -35,10 +35,10 @@ $AccountAttribute = Initialize-PSSailpoint.BetaAccountAttribute -SourceName Wor -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributes.md index 6546f817d225..8387f543a234 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributes.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributes.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountAttributes = Initialize-PSSailpoint.BetaAccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +$AccountAttributes = Initialize-PSSailpoint.BetaAccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributesChangedAccount.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributesChangedAccount.md index 69b7a089a8f8..f173d00232ed 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributesChangedAccount.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountAttributesChangedAccount.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $AccountAttributesChangedAccount = Initialize-PSSailpoint.BetaAccountAttributesChangedAccount -Id 52170a74-ca89-11ea-87d0-0242ac130003 ` -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 ` -Name john.doe ` - -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` -Type ACCOUNT ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountCorrelated.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountCorrelated.md index a53eb620c5bc..16eb40d993b1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountCorrelated.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountCorrelated.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $AccountCorrelated = Initialize-PSSailpoint.BetaAccountCorrelated -Identity null ` -Source null ` -Account null ` - -Attributes {sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]} ` + -Attributes {sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]} ` -EntitlementCount 0 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountCorrelatedAccount.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountCorrelatedAccount.md index 546d4d34cd3c..6332acfed0dc 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountCorrelatedAccount.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountCorrelatedAccount.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $AccountCorrelatedAccount = Initialize-PSSailpoint.BetaAccountCorrelatedAccount -Type ACCOUNT ` -Id 98da47c31df444558c211f9b205184f6 ` -Name Brian Mendoza ` - -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountInfoDto.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountInfoDto.md index 97195de3e5cf..bcf91f3220bc 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountInfoDto.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountInfoDto.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountInfoDto = Initialize-PSSailpoint.BetaAccountInfoDto -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` +$AccountInfoDto = Initialize-PSSailpoint.BetaAccountInfoDto -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -DisplayName Abby.Smith ` -Uuid {ad9fc391-246d-40af-b248-b6556a2b7c01} ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUncorrelatedAccount.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUncorrelatedAccount.md index 9cb82c152f39..3b0ddb14925b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUncorrelatedAccount.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUncorrelatedAccount.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $AccountUncorrelatedAccount = Initialize-PSSailpoint.BetaAccountUncorrelatedAccount -Type ACCOUNT ` -Id 4dd497e3723e439991cb6d0e478375dd ` -Name Sadie Jensen ` - -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md index 9d6d480118b2..f6a1eaaa2640 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/AppAccountDetailsSourceAccount.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AppAccountDetailsSourceAccount.md index 6df75accc3fa..59f603822e05 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AppAccountDetailsSourceAccount.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AppAccountDetailsSourceAccount.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $AppAccountDetailsSourceAccount = Initialize-PSSailpoint.BetaAppAccountDetailsSourceAccount -Id fbf4f72280304f1a8bc808fc2a3bcf7b ` - -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -DisplayName Abby Smith ` -SourceId 10efa58ea3954883b52bf74f489ce8f9 ` -SourceDisplayName ODS-AD-SOURCE diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Approval.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Approval.md index e607fffe6d9b..d2195d61fcd2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Approval.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Approval.md @@ -43,17 +43,17 @@ $Approval = Initialize-PSSailpoint.BetaApproval -ApprovalId 38453251-6be2-5f8f- -CreatedDate 2023-04-12T23:20:50.52Z ` -Type ENTITLEMENT_DESCRIPTIONS ` -Name null ` - -BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} ` + -BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} ` -Description null ` -Priority HIGH ` - -Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} ` + -Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} ` -Comments null ` -ApprovedBy null ` -RejectedBy null ` -CompletedDate 2023-04-12T23:20:50.52Z ` -ApprovalCriteria SINGLE ` -Status PENDING ` - -AdditionalAttributes { "llm_description": "generated description" } ` + -AdditionalAttributes { "llm_description": "generated description" } ` -ReferenceData null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AttrSyncSourceConfig.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AttrSyncSourceConfig.md index f09ca714bbb4..4ae64f572a68 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AttrSyncSourceConfig.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AttrSyncSourceConfig.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $AttrSyncSourceConfig = Initialize-PSSailpoint.BetaAttrSyncSourceConfig -Source null ` - -Attributes [{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}] + -Attributes [{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDTOList.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDTOList.md index 4964b3a2a29e..f0298172a0bf 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDTOList.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDTOList.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AttributeDTOList = Initialize-PSSailpoint.BetaAttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] +$AttributeDTOList = Initialize-PSSailpoint.BetaAttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Base64Decode.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Base64Decode.md index 99663064e4e1..f8d2697ea204 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Base64Decode.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Base64Decode.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Base64Decode = Initialize-PSSailpoint.BetaBase64Decode -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Base64Encode.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Base64Encode.md index 6439fac9b0a0..73d5a17ad8d8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Base64Encode.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Base64Encode.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Base64Encode = Initialize-PSSailpoint.BetaBase64Encode -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/BulkIdentitiesAccountsResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/BulkIdentitiesAccountsResponse.md index cc08f2c0a51e..ac484277dcdd 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/BulkIdentitiesAccountsResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/BulkIdentitiesAccountsResponse.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $BulkIdentitiesAccountsResponse = Initialize-PSSailpoint.BetaBulkIdentitiesAccountsResponse -Id 2c9180858082150f0180893dbaf553fe ` -StatusCode 404 ` - -Message Referenced identity "2c9180858082150f0180893dbaf553fe" was not found. + -Message Referenced identity "2c9180858082150f0180893dbaf553fe" was not found. ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/CompleteInvocation.md b/docs/tools/sdk/powershell/Reference/Beta/Models/CompleteInvocation.md index ae738c729411..bbe16b475c53 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/CompleteInvocation.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/CompleteInvocation.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $CompleteInvocation = Initialize-PSSailpoint.BetaCompleteInvocation -Secret 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` -VarError Access request is denied. ` - -Output {approved=false} + -Output {approved=false} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/CompleteInvocationInput.md b/docs/tools/sdk/powershell/Reference/Beta/Models/CompleteInvocationInput.md index 1078fd50657b..43b5aa4068e1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/CompleteInvocationInput.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/CompleteInvocationInput.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $CompleteInvocationInput = Initialize-PSSailpoint.BetaCompleteInvocationInput -LocalizedError null ` - -Output {approved=false} + -Output {approved=false} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/CompletedApproval.md b/docs/tools/sdk/powershell/Reference/Beta/Models/CompletedApproval.md index 3a593536be0a..1c027314b9b3 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/CompletedApproval.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/CompletedApproval.md @@ -66,7 +66,7 @@ $CompletedApproval = Initialize-PSSailpoint.BetaCompletedApproval -Id 2c9380836 -CurrentRemoveDate 2020-07-11T00:00Z ` -SodViolationContext null ` -PreApprovalTriggerResult null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Concatenation.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Concatenation.md index 6efea18509d3..50218214c806 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Concatenation.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Concatenation.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $Concatenation = Initialize-PSSailpoint.BetaConcatenation -Values [John, , Smith] ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Conditional.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Conditional.md index 2bcd6dea9045..9cc5288801c8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Conditional.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Conditional.md @@ -30,7 +30,7 @@ $Conditional = Initialize-PSSailpoint.BetaConditional -Expression ValueA eq Val -PositiveCondition true ` -NegativeCondition false ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ConnectorDetail.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ConnectorDetail.md index fba5a70eb51f..442566813b5e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ConnectorDetail.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ConnectorDetail.md @@ -29,13 +29,13 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ConnectorDetail = Initialize-PSSailpoint.BetaConnectorDetail -Name JDBC ` - -SourceConfigXml <Form connectorName='Active Directory - Direct' directConnect='true' name='Active Directory' status='released' type='SourceConfig' xmlns='http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd'> - <Field defaultValue='true' hidden='true' name='cloudAuthEnabled' type='boolean' value='true'> </Field> </Form> ` - -SourceConfig {Form={Field={_defaultValue=true, _hidden=true, _name=cloudAuthEnabled, _type=boolean, _value=true}, _xmlns=http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd, _connectorName=Active Directory - Direct, _directConnect=true, _name=Active Directory, _status=released, _type=SourceConfig, __text=\n\t}} ` + -SourceConfigXml
+
` + -SourceConfig {Form={Field={_defaultValue=true, _hidden=true, _name=cloudAuthEnabled, _type=boolean, _value=true}, _xmlns=http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd, _connectorName=Active Directory - Direct, _directConnect=true, _name=Active Directory, _status=released, _type=SourceConfig, __text=\n\t}} ` -DirectConnect true ` -FileUpload false ` -UploadedFiles [] ` - -ConnectorMetadata {supportedUI=EXTJS} + -ConnectorMetadata {supportedUI=EXTJS} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelatedGovernanceEvent.md index bb3352b1fb0c..e6e6d96b94f0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelatedGovernanceEvent.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelatedGovernanceEvent.md @@ -32,8 +32,8 @@ $CorrelatedGovernanceEvent = Initialize-PSSailpoint.BetaCorrelatedGovernanceEven -Dt 2019-03-08T22:37:33.901Z ` -Type certification ` -GovernanceId 2c91808a77ff216301782327a50f09bf ` - -Owners [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Owners [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` -DecisionMaker null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelationConfigAttributeAssignmentsInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelationConfigAttributeAssignmentsInner.md index ae98f9a913a8..142f8ac43c42 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelationConfigAttributeAssignmentsInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelationConfigAttributeAssignmentsInner.md @@ -34,7 +34,7 @@ $CorrelationConfigAttributeAssignmentsInner = Initialize-PSSailpoint.BetaCorrela -Complex false ` -IgnoreCase false ` -MatchMode ANYWHERE ` - -FilterString first_name == "John" + -FilterString first_name == "John" ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/CreateFormInstanceRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/CreateFormInstanceRequest.md index 67a6f72b4702..0229117a6418 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/CreateFormInstanceRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/CreateFormInstanceRequest.md @@ -32,7 +32,7 @@ Name | Type | Description | Notes $CreateFormInstanceRequest = Initialize-PSSailpoint.BetaCreateFormInstanceRequest -CreatedBy null ` -Expire 2023-08-12T20:14:57.74486Z ` -FormDefinitionId 00000000-0000-0000-0000-000000000000 ` - -FormInput {input1=Sales} ` + -FormInput {input1=Sales} ` -Recipients null ` -StandAloneForm false ` -State ASSIGNED ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/CreateWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/CreateWorkflowRequest.md index 10a321883dec..33de3db6405f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/CreateWorkflowRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/CreateWorkflowRequest.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes ```powershell $CreateWorkflowRequest = Initialize-PSSailpoint.BetaCreateWorkflowRequest -Name Send Email ` -Owner null ` - -Description Send an email to the identity who's attributes changed. ` + -Description Send an email to the identity who's attributes changed. ` -Definition null ` -Enabled false ` -Trigger null diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompare.md b/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompare.md index 3285736c0d96..ec8f6dca7a55 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompare.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompare.md @@ -34,7 +34,7 @@ $DateCompare = Initialize-PSSailpoint.BetaDateCompare -FirstDate null ` -PositiveCondition true ` -NegativeCondition false ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompareFirstDate.md b/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompareFirstDate.md index 8d73a3a40dd9..adc52db34d51 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompareFirstDate.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompareFirstDate.md @@ -37,10 +37,10 @@ $DateCompareFirstDate = Initialize-PSSailpoint.BetaDateCompareFirstDate -Source -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` -InputFormat null ` -OutputFormat null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompareSecondDate.md b/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompareSecondDate.md index 232dc179eb6f..37485affa018 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompareSecondDate.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/DateCompareSecondDate.md @@ -37,10 +37,10 @@ $DateCompareSecondDate = Initialize-PSSailpoint.BetaDateCompareSecondDate -Sour -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` -InputFormat null ` -OutputFormat null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/DateFormat.md b/docs/tools/sdk/powershell/Reference/Beta/Models/DateFormat.md index 0742f8cb656b..32686ebff386 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/DateFormat.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/DateFormat.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $DateFormat = Initialize-PSSailpoint.BetaDateFormat -InputFormat null ` -OutputFormat null ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/DateMath.md b/docs/tools/sdk/powershell/Reference/Beta/Models/DateMath.md index b0ecac7f4bd2..a3740cf615a1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/DateMath.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/DateMath.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $DateMath = Initialize-PSSailpoint.BetaDateMath -Expression now+1w ` -RoundUp false ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/DecomposeDiacriticalMarks.md b/docs/tools/sdk/powershell/Reference/Beta/Models/DecomposeDiacriticalMarks.md index 4812f72b88e4..c4ec12acc92d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/DecomposeDiacriticalMarks.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/DecomposeDiacriticalMarks.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $DecomposeDiacriticalMarks = Initialize-PSSailpoint.BetaDecomposeDiacriticalMarks -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/E164phone.md b/docs/tools/sdk/powershell/Reference/Beta/Models/E164phone.md index c2def83e2586..a081c1f84586 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/E164phone.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/E164phone.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $E164phone = Initialize-PSSailpoint.BetaE164phone -DefaultRegion US ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Entitlement.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Entitlement.md index d860b077d950..9794908fa0fe 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Entitlement.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Entitlement.md @@ -44,13 +44,13 @@ $Entitlement = Initialize-PSSailpoint.BetaEntitlement -Id 2c91808874ff915501750 -Created 2020-10-08T18:33:52.029Z ` -Modified 2020-10-08T18:33:52.029Z ` -Attribute memberOf ` - -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` -SourceSchemaObjectType group ` -Privileged true ` -CloudGoverned true ` - -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` -Requestable true ` - -Attributes {fieldName=fieldValue} ` + -Attributes {fieldName=fieldValue} ` -Source null ` -Owner null ` -DirectPermissions null ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementAccessModelMetadata.md index 09a5ff20272c..aeca0e2a3290 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementAccessModelMetadata.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementAccessModelMetadata.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$EntitlementAccessModelMetadata = Initialize-PSSailpoint.BetaEntitlementAccessModelMetadata -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] +$EntitlementAccessModelMetadata = Initialize-PSSailpoint.BetaEntitlementAccessModelMetadata -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementBulkUpdateRequest.md index 5c7a3ac2f204..9e25d36aa7ce 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementBulkUpdateRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementBulkUpdateRequest.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $EntitlementBulkUpdateRequest = Initialize-PSSailpoint.BetaEntitlementBulkUpdateRequest -EntitlementIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] ` - -JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}] + -JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementRef.md index c0cd43e07a3b..a4e1019ae34c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementRef.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementRef.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $EntitlementRef = Initialize-PSSailpoint.BetaEntitlementRef -Type ENTITLEMENT ` -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/EventAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/Models/EventAttributes.md index d792fa474fda..354114a81957 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/EventAttributes.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/EventAttributes.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $EventAttributes = Initialize-PSSailpoint.BetaEventAttributes -Id idn:identity-attributes-changed ` - -VarFilter $.changes[?(@.attribute == 'manager')] ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` -Description null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteria.md index 3b1675d7ab8f..955d7c5e5b7a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteria.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteria.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ExceptionCriteria = Initialize-PSSailpoint.BetaExceptionCriteria -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] +$ExceptionCriteria = Initialize-PSSailpoint.BetaExceptionCriteria -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteriaAccess.md index 0d49b9781caa..7b65f57414a8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteriaAccess.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteriaAccess.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes ```powershell $ExceptionCriteriaAccess = Initialize-PSSailpoint.BetaExceptionCriteriaAccess -Type null ` -Id 2c91808568c529c60168cca6f90c1313 ` - -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` -Existing true ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteriaCriteriaListInner.md index 90e6802fa5a6..123a4b5a7077 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteriaCriteriaListInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ExceptionCriteriaCriteriaListInner.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes ```powershell $ExceptionCriteriaCriteriaListInner = Initialize-PSSailpoint.BetaExceptionCriteriaCriteriaListInner -Type ENTITLEMENT ` -Id 2c91808568c529c60168cca6f90c1313 ` - -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` -Existing true ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ExportOptions.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ExportOptions.md index 96134577bbb7..20a407541b51 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ExportOptions.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ExportOptions.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $ExportOptions = Initialize-PSSailpoint.BetaExportOptions -ExcludeTypes null ` -IncludeTypes null ` - -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ExportPayload.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ExportPayload.md index 147457d6fc46..7dcfc031d801 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ExportPayload.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ExportPayload.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $ExportPayload = Initialize-PSSailpoint.BetaExportPayload -Description Export Job 1 Test ` -ExcludeTypes null ` -IncludeTypes null ` - -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Field.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Field.md index 2b2f577efbc7..35ddd515c603 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Field.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Field.md @@ -31,7 +31,7 @@ $Field = Initialize-PSSailpoint.BetaField -Name Field1 ` -DisplayName Field 1 ` -DisplayType checkbox ` -Required null ` - -AllowedValuesList [{Val1Display=null, Val1Value=null}, {Val2Display=null, Val2Value=null}] ` + -AllowedValuesList [{Val1Display=null, Val1Value=null}, {Val2Display=null, Val2Value=null}] ` -Value null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/FieldDetails.md b/docs/tools/sdk/powershell/Reference/Beta/Models/FieldDetails.md index 1faaadacf272..d1f146cfee1a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/FieldDetails.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/FieldDetails.md @@ -31,7 +31,7 @@ $FieldDetails = Initialize-PSSailpoint.BetaFieldDetails -Name Field1 ` -DisplayName Field 1 ` -DisplayType checkbox ` -Required null ` - -AllowedValuesList [{Val1Display=null, Val1Value=null}, {Val2Display=null, Val2Value=null}] ` + -AllowedValuesList [{Val1Display=null, Val1Value=null}, {Val2Display=null, Val2Value=null}] ` -Value null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/FieldDetailsDto.md b/docs/tools/sdk/powershell/Reference/Beta/Models/FieldDetailsDto.md index 24e2d2cf78fe..54021c6d8bf4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/FieldDetailsDto.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/FieldDetailsDto.md @@ -28,8 +28,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $FieldDetailsDto = Initialize-PSSailpoint.BetaFieldDetailsDto -Name userName ` - -Transform {type=rule, attributes={name=Create Unique LDAP Attribute}} ` - -Attributes {template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true} ` + -Transform {type=rule, attributes={name=Create Unique LDAP Attribute}} ` + -Attributes {template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true} ` -IsRequired false ` -Type string ` -IsMultiValued false diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/FirstValid.md b/docs/tools/sdk/powershell/Reference/Beta/Models/FirstValid.md index 1b69e76448a5..ae528ca3bf61 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/FirstValid.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/FirstValid.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$FirstValid = Initialize-PSSailpoint.BetaFirstValid -Values [{attributes={sourceName=Active Directory, attributeName=sAMAccountName}, type=accountAttribute}, {attributes={sourceName=Okta, attributeName=login}, type=accountAttribute}, {attributes={sourceName=HR Source, attributeName=employeeID}, type=accountAttribute}] ` +$FirstValid = Initialize-PSSailpoint.BetaFirstValid -Values [{attributes={sourceName=Active Directory, attributeName=sAMAccountName}, type=accountAttribute}, {attributes={sourceName=Okta, attributeName=login}, type=accountAttribute}, {attributes={sourceName=HR Source, attributeName=employeeID}, type=accountAttribute}] ` -IgnoreErrors false ` -RequiresPeriodicRefresh false ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/FormDefinitionDynamicSchemaResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/FormDefinitionDynamicSchemaResponse.md index 8607ea226fe5..eb1df4b5ca1f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/FormDefinitionDynamicSchemaResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/FormDefinitionDynamicSchemaResponse.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$FormDefinitionDynamicSchemaResponse = Initialize-PSSailpoint.BetaFormDefinitionDynamicSchemaResponse -OutputSchema {outputSchema={$schema=https://json-schema.org/draft/2020-12/schema, additionalProperties=false, properties={firstName={title=First Name, type=string}, fullName={title=Full Name, type=string}, lastName={title=Last Name, type=string}, startDate={format=date-time, title=Start Date, type=string}}, type=object}} +$FormDefinitionDynamicSchemaResponse = Initialize-PSSailpoint.BetaFormDefinitionDynamicSchemaResponse -OutputSchema {outputSchema={$schema=https://json-schema.org/draft/2020-12/schema, additionalProperties=false, properties={firstName={title=First Name, type=string}, fullName={title=Full Name, type=string}, lastName={title=Last Name, type=string}, startDate={format=date-time, title=Start Date, type=string}}, type=object}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/FormElement.md b/docs/tools/sdk/powershell/Reference/Beta/Models/FormElement.md index 77e6722d0dae..fb163eb44ec9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/FormElement.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/FormElement.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes ```powershell $FormElement = Initialize-PSSailpoint.BetaFormElement -Id 00000000-0000-0000-0000-000000000000 ` -ElementType TEXT ` - -Config {label=Department} ` + -Config {label=Department} ` -Key department ` -Validations null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/FormInstanceResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/FormInstanceResponse.md index 2672ed0479ef..b5afb684a84f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/FormInstanceResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/FormInstanceResponse.md @@ -40,11 +40,11 @@ $FormInstanceResponse = Initialize-PSSailpoint.BetaFormInstanceResponse -Create -CreatedBy null ` -Expire 2023-08-12T20:14:57.74486Z ` -FormConditions null ` - -FormData {department=Engineering} ` + -FormData {department=Engineering} ` -FormDefinitionId 49841cb8-00a5-4fbd-9888-8bbb28d48331 ` -FormElements null ` -FormErrors null ` - -FormInput {input1=Sales} ` + -FormInput {input1=Sales} ` -Id 06a2d961-07fa-44d1-8d0a-2f6470e30fd2 ` -Modified 2023-07-12T20:14:57.744860Z ` -Recipients null ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md index 6141a2adb634..eab827df1afb 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -46,8 +46,8 @@ $GetHistoricalIdentityEvents200ResponseInner = Initialize-PSSailpoint.BetaGetHis -CertificationId 2c91808a77ff216301782327a50f09bf ` -CertificationName Cert name ` -SignedDate 2019-03-08T22:37:33.901Z ` - -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` -Signer null ` -Account null ` -StatusChange null diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/GetRoleAssignments200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/GetRoleAssignments200ResponseInner.md index 17a8f9577b06..acad436b20dc 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/GetRoleAssignments200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/GetRoleAssignments200ResponseInner.md @@ -32,10 +32,10 @@ Name | Type | Description | Notes ```powershell $GetRoleAssignments200ResponseInner = Initialize-PSSailpoint.BetaGetRoleAssignments200ResponseInner -Id 1cbb0705b38c4226b1334eadd8874086 ` -Role null ` - -Comments I'm a new Engineer and need this role to do my work ` + -Comments I'm a new Engineer and need this role to do my work ` -AssignmentSource UI ` -Assigner null ` - -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` + -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` -AssignmentContext null ` -AccountTargets null ` -RemoveDate Wed Feb 14 10:58:42 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ISO3166.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ISO3166.md index 442e15e0c399..473d52b18863 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ISO3166.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ISO3166.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $ISO3166 = Initialize-PSSailpoint.BetaISO3166 -Format alpha2 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Identity.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Identity.md index bd56e7dbfb94..7fd80e7f2e71 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Identity.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Identity.md @@ -45,7 +45,7 @@ $Identity = Initialize-PSSailpoint.BetaIdentity -Id 01f04e428c484542a241dc89c30 -ManagerRef null ` -IsManager true ` -LastRefresh 2020-11-22T15:42:31.123Z ` - -Attributes {uid=86754, firstname=Walter, cloudStatus=UNREGISTERED, displayName=Walter White, identificationNumber=86754, lastSyncDate=1470348809380, email=walter.white@example.com, lastname=White} ` + -Attributes {uid=86754, firstname=Walter, cloudStatus=UNREGISTERED, displayName=Walter White, identificationNumber=86754, lastSyncDate=1470348809380, email=walter.white@example.com, lastname=White} ` -LifecycleState null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md index ad31fd8d7068..65a7ca626024 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityAssociationDetailsAssociationDetailsInner = Initialize-PSSailpoint.BetaIdentityAssociationDetailsAssociationDetailsInner -AssociationType CAMPAIGN_OWNER ` - -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=CAMPAIGN_CAMPAIGNER} + -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=CAMPAIGN_CAMPAIGNER} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttribute1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttribute1.md index d9f65c304b3e..64c089bfb2ae 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttribute1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttribute1.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $IdentityAttribute1 = Initialize-PSSailpoint.BetaIdentityAttribute1 -Name email ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md index d77241abdb65..ec5a872e1ffa 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'BetaIdenti Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $true] +**Enabled** | **Boolean** | If the profile or mapping is enabled | [optional] [default to $true] **AttributeTransforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md index aaff6049b9af..b196d282f46c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig1', 'BetaIdent Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**Enabled** | **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] **AttributeTransforms** | [**[]IdentityAttributeTransform1**](identity-attribute-transform1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md index 577385071926..842ae324672a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'BetaIde Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] +**IdentityAttributeName** | **String** | Name of the identity attribute | [optional] **TransformDefinition** | [**TransformDefinition**](transform-definition) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md index f3e2f164598f..0566d880c92b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform1', 'BetaId Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] +**IdentityAttributeName** | **String** | Name of the identity attribute. | [optional] **TransformDefinition** | [**TransformDefinition1**](transform-definition1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCertified.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCertified.md index 274f86d36993..5b9aa459f15d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCertified.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCertified.md @@ -32,8 +32,8 @@ Name | Type | Description | Notes $IdentityCertified = Initialize-PSSailpoint.BetaIdentityCertified -CertificationId 2c91808a77ff216301782327a50f09bf ` -CertificationName Cert name ` -SignedDate 2019-03-08T22:37:33.901Z ` - -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` -Signer null ` -EventType IdentityCertified ` -Dt 2019-03-08T22:37:33.901Z diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCreated.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCreated.md index b6a16016b94b..5488524e6b5f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCreated.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCreated.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityCreated = Initialize-PSSailpoint.BetaIdentityCreated -Identity null ` - -Attributes {firstname=John} + -Attributes {firstname=John} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityDeleted.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityDeleted.md index 468f0f7d0fe8..03135e8f6b72 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityDeleted.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityDeleted.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityDeleted = Initialize-PSSailpoint.BetaIdentityDeleted -Identity null ` - -Attributes {firstname=John} + -Attributes {firstname=John} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md index b35016972b19..e67b7642a309 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'B Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | Task result ID. | [optional] -**ReportName** | **String** | Report name. | [optional] +**TaskResultId** | **String** | The id of the task result | [optional] +**ReportName** | **String** | The name of the report | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md index 5d6d544e49e5..ff6802237a6c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference1', ' Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | Task result ID. | [optional] -**ReportName** | **String** | Report name. | [optional] +**TaskResultId** | **String** | The id of the task result. | [optional] +**ReportName** | **String** | The name of the report. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityHistoryResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityHistoryResponse.md index 541600f8732f..6b10d947508f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityHistoryResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityHistoryResponse.md @@ -31,8 +31,8 @@ $IdentityHistoryResponse = Initialize-PSSailpoint.BetaIdentityHistoryResponse - -DisplayName Adam Zampa ` -Snapshot 2007-03-01T13:00:00.000Z ` -DeletedDate 2007-03-01T13:00:00.000Z ` - -AccessItemCount {app=0, role=2, entitlement=4, accessProfile=3, account=1} ` - -Attributes {jobTitle=HR Manager, location=NYC, firstname=Adam, lastname=Zampa, department=HR} + -AccessItemCount {app=0, role=2, entitlement=4, accessProfile=3, account=1} ` + -Attributes {jobTitle=HR Manager, location=NYC, firstname=Adam, lastname=Zampa, department=HR} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md index 8f21776c847f..743c58bdbd04 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityOwnershipAssociationDetailsAssociationDetailsInner = Initialize-PSSailpoint.BetaIdentityOwnershipAssociationDetailsAssociationDetailsInner -AssociationType ROLE_OWNER ` - -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=ROLE} + -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=ROLE} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md index a83a0e0695e7..bd7871006f9e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | Identity profile's description. | [optional] +**Description** | **String** | The description of the Identity Profile. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | Identity profile's priority. | [optional] +**Priority** | **Int64** | The priority for an Identity Profile. | [optional] **AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] -**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made | [optional] [default to $false] +**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $true] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $true] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md index 30245f14af13..2bc7191bdf72 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | Identity profile's description. | [optional] +**Description** | **String** | The description of the Identity Profile. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | Identity profile's priority. | [optional] +**Priority** | **Int64** | The priority for an Identity Profile. | [optional] **AuthoritativeSource** | [**IdentityProfile1AllOfAuthoritativeSource**](identity-profile1-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] -**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] +**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig1**](identity-attribute-config1) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference1**](identity-exception-report-reference1) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md index 7b50f0f25c5a..82b6803bf0a4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfile1AllOfAuthoritativeSou Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] -**Id** | **String** | Authoritative source's ID. | [optional] -**Name** | **String** | Authoritative source's name. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] +**Id** | **String** | ID of the object to which this reference applies | [optional] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md index 11dbdeb896ce..ef7b5a835c81 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] -**Id** | **String** | Authoritative source's ID. | [optional] -**Name** | **String** | Authoritative source's name. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] +**Id** | **String** | ID of the object to which this reference applies | [optional] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md index f2ac84e83cd4..f0a586e8674c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'BetaIden Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Owner's object type. | [optional] -**Id** | **String** | Owner's ID. | [optional] -**Name** | **String** | Owner's name. | [optional] +**Type** | **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] +**Id** | **String** | ID of the object to which this reference applies | [optional] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentitySyncPayload.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentitySyncPayload.md index 3d3118020f94..447cfa016d77 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentitySyncPayload.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentitySyncPayload.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentitySyncPayload = Initialize-PSSailpoint.BetaIdentitySyncPayload -Type SYNCHRONIZE_IDENTITY_ATTRIBUTES ` - -DataJson {"identityId":"2c918083746f642c01746f990884012a"} + -DataJson {"identityId":"2c918083746f642c01746f990884012a"} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccess.md index f5ed37cdcce6..2db96db825bf 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccess.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccess.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityWithNewAccess = Initialize-PSSailpoint.BetaIdentityWithNewAccess -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}] + -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}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md index 8db5e49e9a76..361c1b6d50fe 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityWithNewAccessAccessRefsInner.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $IdentityWithNewAccessAccessRefsInner = Initialize-PSSailpoint.BetaIdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT ` -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ImportOptions.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ImportOptions.md index 3e9484245de5..300cd6bd1d27 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ImportOptions.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ImportOptions.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes ```powershell $ImportOptions = Initialize-PSSailpoint.BetaImportOptions -ExcludeTypes null ` -IncludeTypes null ` - -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} ` + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} ` -DefaultReferences null ` -ExcludeBackup false ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IndexOf.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IndexOf.md index 5599e43270fc..26a5daed9105 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IndexOf.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IndexOf.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $IndexOf = Initialize-PSSailpoint.BetaIndexOf -Substring admin_ ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Invocation.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Invocation.md index effba8d1f6da..d198cd5706cf 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Invocation.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Invocation.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $Invocation = Initialize-PSSailpoint.BetaInvocation -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` -TriggerId idn:access-requested ` -Secret 0f979022-08be-44f2-b6f9-7393ec73ed9b ` - -ContentJson {workflowId=1234} + -ContentJson {workflowId=1234} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/KbaAnswerResponseItem.md index 3a7c1cccd891..b2abf0171768 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/KbaAnswerResponseItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/KbaAnswerResponseItem.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $KbaAnswerResponseItem = Initialize-PSSailpoint.BetaKbaAnswerResponseItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` - -Question [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -Question [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` -HasAnswer true ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/KbaAuthResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/KbaAuthResponse.md index a898738252b8..44ccfc88a2ae 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/KbaAuthResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/KbaAuthResponse.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$KbaAuthResponse = Initialize-PSSailpoint.BetaKbaAuthResponse -KbaAuthResponseItems [{questionId=089899f13a8f4da7824996191587bab9, isVerified=false}] ` +$KbaAuthResponse = Initialize-PSSailpoint.BetaKbaAuthResponse -KbaAuthResponseItems [{questionId=089899f13a8f4da7824996191587bab9, isVerified=false}] ` -Status PENDING ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/KbaQuestion.md b/docs/tools/sdk/powershell/Reference/Beta/Models/KbaQuestion.md index 908d81e59e8b..ce45d506f4be 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/KbaQuestion.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/KbaQuestion.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $KbaQuestion = Initialize-PSSailpoint.BetaKbaQuestion -Id 143cfd3b-c23f-426b-ae5f-d3db06fa5919 ` - -Text [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -Text [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` -HasAnswer true ` -NumAnswers 5 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Launcher.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Launcher.md index 9d5fd0a92c2d..fe91a3e4b692 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Launcher.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Launcher.md @@ -40,7 +40,7 @@ $Launcher = Initialize-PSSailpoint.BetaLauncher -Id 1b630bed-0941-4792-a712-57a -Type INTERACTIVE_PROCESS ` -Disabled false ` -Reference null ` - -Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"} + -Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/LauncherRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/LauncherRequest.md index 427e5085db84..33b91821436a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/LauncherRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/LauncherRequest.md @@ -32,7 +32,7 @@ $LauncherRequest = Initialize-PSSailpoint.BetaLauncherRequest -Name Group Creat -Type INTERACTIVE_PROCESS ` -Disabled false ` -Reference null ` - -Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"} + -Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/LeftPad.md b/docs/tools/sdk/powershell/Reference/Beta/Models/LeftPad.md index 009c7ed2db79..6d197513d2a5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/LeftPad.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/LeftPad.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $LeftPad = Initialize-PSSailpoint.BetaLeftPad -Length 4 ` -Padding 0 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md index 00bab27cb005..60b6a07952c8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -38,7 +38,7 @@ $ListCompleteWorkflowLibrary200ResponseInner = Initialize-PSSailpoint.BetaListCo -Name Compare Boolean Values ` -Type OPERATOR ` -Description Compare two boolean values and decide what happens based on the result. ` - -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ` + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ` -ExampleOutput null ` -Deprecated null ` -DeprecatedBy null ` @@ -46,7 +46,7 @@ $ListCompleteWorkflowLibrary200ResponseInner = Initialize-PSSailpoint.BetaListCo -IsSimulationEnabled null ` -IsDynamicSchema false ` -OutputSchema null ` - -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ListFormElementDataByElementIDResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ListFormElementDataByElementIDResponse.md index 8588aa754347..0545e660f0f9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ListFormElementDataByElementIDResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ListFormElementDataByElementIDResponse.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ListFormElementDataByElementIDResponse = Initialize-PSSailpoint.BetaListFormElementDataByElementIDResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} +$ListFormElementDataByElementIDResponse = Initialize-PSSailpoint.BetaListFormElementDataByElementIDResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/LoadEntitlementTask.md b/docs/tools/sdk/powershell/Reference/Beta/Models/LoadEntitlementTask.md index 42966f9c1ce7..1c1d03d3a94a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/LoadEntitlementTask.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/LoadEntitlementTask.md @@ -34,7 +34,7 @@ $LoadEntitlementTask = Initialize-PSSailpoint.BetaLoadEntitlementTask -Id ef38f -Description Aggregate from the specified application ` -Launcher John Doe ` -Created 2020-07-11T21:23:15Z ` - -Returns [{displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_CREATED, attributeName=groupsCreated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_UPDATED, attributeName=groupsUpdated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_DELETED, attributeName=groupsDeleted}] + -Returns [{displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_CREATED, attributeName=groupsCreated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_UPDATED, attributeName=groupsUpdated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_DELETED, attributeName=groupsDeleted}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTask.md b/docs/tools/sdk/powershell/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTask.md index f64999df7d98..73a5cfcae05c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTask.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/LoadUncorrelatedAccountsTaskTask.md @@ -48,7 +48,7 @@ $LoadUncorrelatedAccountsTaskTask = Initialize-PSSailpoint.BetaLoadUncorrelatedA -Messages [] ` -Progress Initializing... ` -Attributes null ` - -Returns [{displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IGNORED, attributeName=correlationFailures}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_FAILURES, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION__CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED, attributeName=groupsCreated}] + -Returns [{displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IGNORED, attributeName=correlationFailures}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_FAILURES, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION__CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED, attributeName=groupsCreated}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Lookup.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Lookup.md index d9d3f7dc1ffb..f78ef9827645 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Lookup.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Lookup.md @@ -24,9 +24,9 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Lookup = Initialize-PSSailpoint.BetaLookup -Table {USA=Americas, FRA=EMEA, AUS=APAC, default=Unknown Region} ` +$Lookup = Initialize-PSSailpoint.BetaLookup -Table {USA=Americas, FRA=EMEA, AUS=APAC, default=Unknown Region} ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Lower.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Lower.md index a4490cd3e9e0..0a7bb724c6dc 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Lower.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Lower.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Lower = Initialize-PSSailpoint.BetaLower -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/MailFromAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/Models/MailFromAttributes.md index d28387aebbe6..296f37616edf 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/MailFromAttributes.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/MailFromAttributes.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $MailFromAttributes = Initialize-PSSailpoint.BetaMailFromAttributes -Identity bob.smith@sailpoint.com ` -MailFromDomain foo.sailpoint.com ` -MxRecord 10 feedback-smtp.us-east-1.amazonses.com ` - -TxtRecord v=spf1 include:amazonses.com ~all ` + -TxtRecord v=spf1 include:amazonses.com ~all ` -MailFromDomainStatus PENDING ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedClientStatus.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedClientStatus.md index 3672f6db7633..d8444c845e8e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedClientStatus.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedClientStatus.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ManagedClientStatus = Initialize-PSSailpoint.BetaManagedClientStatus -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=, state=null, status=NORMAL, uuid=null, product=idn, va_version=null, platform_version=2, os_version=2345.3.1, os_type=flatcar, hypervisor=unknown} ` +$ManagedClientStatus = Initialize-PSSailpoint.BetaManagedClientStatus -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=, state=null, status=NORMAL, uuid=null, product=idn, va_version=null, platform_version=2, os_version=2345.3.1, os_type=flatcar, hypervisor=unknown} ` -Status null ` -Type null ` -Timestamp 2020-01-01T00:00Z diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedClientStatusAggResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedClientStatusAggResponse.md index 1e805fd1db89..c04524c98d50 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedClientStatusAggResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedClientStatusAggResponse.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ManagedClientStatusAggResponse = Initialize-PSSailpoint.BetaManagedClientStatusAggResponse -Body {body={id=1528, clientId=1528, clusterId=1533, orgType=test, vaDownloadUrl=https://sptcbu-va-images.s3.amazonaws.com/va-latest.zip, clusterJobCount=1, configuration={clusterType=sqsCluster, clusterExternalId=2c91808876dd79120176f758af765c58, debug=false, failureThreshold=0, gmtOffset=-6, scheduleUpgrade=false, va_version=va-megapod-useast1-595-1627543540, jobType=VA_UPGRADE, cookbook=va-megapod-useast1-595-1627543540}, connectorServices=[{id=540696, name=EndToEnd-ADSource, connector_host=host.example.com, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540698, name=EndToEnd-AzureADSource, connector_host=null, connector_port=null, connector_(boolean)useSSL=null, connectorFileUploadHistory=null}, {id=540710, name=EndToEnd-OpenLDAP, connector_host=10.0.2.64, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540713, name=Dynamic-ADSource, connector_host=host.example.com, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540716, name=EndToEnd-JdbcADSource, connector_host=10.0.5.187, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540717, name=EndToEnd-JdbcSource, connector_host=null, connector_port=null, connector_(boolean)useSSL=null, connectorFileUploadHistory=[{serviceId=540717, date=2021-02-05T22:58:15Z, file=temp7081703651350031905mysql-connector-java-8.0.11.jar}]}], jobs=[{uuid=872b622f-5ab5-4836-9172-e3bb77f05b2c, cookbook=872b622f-5ab5-4836-9172-e3bb77f05b2c, state=FINISHED, type=VA_UPGRADE, targetId=1528, managedProcessConfiguration={charon={version=345, path=sailpoint/charon, description=null, dependencies=null}, ccg={version=415_583_79.0.0, path=sailpoint/ccg, description=null, dependencies=null}, toolbox={version=6, path=sailpoint/toolbox, description=null, dependencies=null}, fluent={version=50, path=fluent/va, description=null, dependencies=null}, va_agent={version=89, path=sailpoint/va_agent, description=null, dependencies=null}}}], queue={name=megapod-useast1-denali-lwt-cluster-1533, region=us-east-1}, maintenance={window=true, windowStartTime=2021-07-29T00:00:00Z, windowClusterTime=2021-07-29T01:35:24Z, windowFinishTime=2021-07-29T04:00:00Z}}} ` +$ManagedClientStatusAggResponse = Initialize-PSSailpoint.BetaManagedClientStatusAggResponse -Body {body={id=1528, clientId=1528, clusterId=1533, orgType=test, vaDownloadUrl=https://sptcbu-va-images.s3.amazonaws.com/va-latest.zip, clusterJobCount=1, configuration={clusterType=sqsCluster, clusterExternalId=2c91808876dd79120176f758af765c58, debug=false, failureThreshold=0, gmtOffset=-6, scheduleUpgrade=false, va_version=va-megapod-useast1-595-1627543540, jobType=VA_UPGRADE, cookbook=va-megapod-useast1-595-1627543540}, connectorServices=[{id=540696, name=EndToEnd-ADSource, connector_host=host.example.com, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540698, name=EndToEnd-AzureADSource, connector_host=null, connector_port=null, connector_(boolean)useSSL=null, connectorFileUploadHistory=null}, {id=540710, name=EndToEnd-OpenLDAP, connector_host=10.0.2.64, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540713, name=Dynamic-ADSource, connector_host=host.example.com, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540716, name=EndToEnd-JdbcADSource, connector_host=10.0.5.187, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540717, name=EndToEnd-JdbcSource, connector_host=null, connector_port=null, connector_(boolean)useSSL=null, connectorFileUploadHistory=[{serviceId=540717, date=2021-02-05T22:58:15Z, file=temp7081703651350031905mysql-connector-java-8.0.11.jar}]}], jobs=[{uuid=872b622f-5ab5-4836-9172-e3bb77f05b2c, cookbook=872b622f-5ab5-4836-9172-e3bb77f05b2c, state=FINISHED, type=VA_UPGRADE, targetId=1528, managedProcessConfiguration={charon={version=345, path=sailpoint/charon, description=null, dependencies=null}, ccg={version=415_583_79.0.0, path=sailpoint/ccg, description=null, dependencies=null}, toolbox={version=6, path=sailpoint/toolbox, description=null, dependencies=null}, fluent={version=50, path=fluent/va, description=null, dependencies=null}, va_agent={version=89, path=sailpoint/va_agent, description=null, dependencies=null}}}], queue={name=megapod-useast1-denali-lwt-cluster-1533, region=us-east-1}, maintenance={window=true, windowStartTime=2021-07-29T00:00:00Z, windowClusterTime=2021-07-29T01:35:24Z, windowFinishTime=2021-07-29T04:00:00Z}}} ` -Status null ` -Type null ` -Timestamp 2020-01-01T00:00Z diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedCluster.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedCluster.md index 8f23454a9ca3..3bc4104b65d2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedCluster.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ManagedCluster.md @@ -51,7 +51,7 @@ $ManagedCluster = Initialize-PSSailpoint.BetaManagedCluster -Id aClusterId ` -Pod megapod-useast1 ` -Org denali ` -Type null ` - -Configuration {clusterExternalId=externalId, ccgVersion=77.0.0} ` + -Configuration {clusterExternalId=externalId, ccgVersion=77.0.0} ` -KeyPair null ` -Attributes null ` -Description A short description of the managed cluster. ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ManualDiscoverApplications.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ManualDiscoverApplications.md index 27e6429e89c8..8988a4b6fd17 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ManualDiscoverApplications.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ManualDiscoverApplications.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ManualDiscoverApplications = Initialize-PSSailpoint.BetaManualDiscoverApplications -File application_name,description -"Sample App","This is a sample description for Sample App." -"Another App","Description for Another App." +"Sample App","This is a sample description for Sample App." +"Another App","Description for Another App." ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/MatchTerm.md b/docs/tools/sdk/powershell/Reference/Beta/Models/MatchTerm.md index e258f3e16959..22f84d57bb0a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/MatchTerm.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/MatchTerm.md @@ -32,7 +32,7 @@ $MatchTerm = Initialize-PSSailpoint.BetaMatchTerm -Name mail ` -Op eq ` -Container true ` -And false ` - -Children [{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}] + -Children [{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/MfaDuoConfig.md b/docs/tools/sdk/powershell/Reference/Beta/Models/MfaDuoConfig.md index c0ff455161db..59c0a71d502c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/MfaDuoConfig.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/MfaDuoConfig.md @@ -32,7 +32,7 @@ $MfaDuoConfig = Initialize-PSSailpoint.BetaMfaDuoConfig -MfaMethod duo-web ` -VarHost example.com ` -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` -IdentityAttribute email ` - -ConfigProperties {skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} + -ConfigProperties {skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostIntegrationsCreate.md b/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostIntegrationsCreate.md index 38cd31e11f96..c40fce374af5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostIntegrationsCreate.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostIntegrationsCreate.md @@ -35,7 +35,7 @@ $MultiHostIntegrationsCreate = Initialize-PSSailpoint.BetaMultiHostIntegrationsC -Owner null ` -Cluster null ` -Connector multihost-microsoft-sql-server ` - -ConnectorAttributes {maxSourcesPerAggGroup=10, maxAllowedSources=300} ` + -ConnectorAttributes {maxSourcesPerAggGroup=10, maxAllowedSources=300} ` -ManagementWorkgroup null ` -Created 2022-02-08T14:50:03.827Z ` -Modified 2024-01-23T18:08:50.897Z diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostIntegrationsCreateSources.md b/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostIntegrationsCreateSources.md index 92bc228f1ca7..949c1ee21bfd 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostIntegrationsCreateSources.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostIntegrationsCreateSources.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $MultiHostIntegrationsCreateSources = Initialize-PSSailpoint.BetaMultiHostIntegrationsCreateSources -Name My Source ` -Description This is the corporate directory. ` - -ConnectorAttributes {authType=SQLAuthentication, url=jdbc:sqlserver://178.18.41.118:1433, user=username, driverClass=com.microsoft.sqlserver.jdbc.SQLServerDriver, maxSourcesPerAggGroup=10, maxAllowedSources=300} + -ConnectorAttributes {authType=SQLAuthentication, url=jdbc:sqlserver://178.18.41.118:1433, user=username, driverClass=com.microsoft.sqlserver.jdbc.SQLServerDriver, maxSourcesPerAggGroup=10, maxAllowedSources=300} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostSources.md b/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostSources.md index 61a784476df0..c68898d9e66b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostSources.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/MultiHostSources.md @@ -62,13 +62,13 @@ $MultiHostSources = Initialize-PSSailpoint.BetaMultiHostSources -Id 2c91808568c -ManagerCorrelationMapping null ` -ManagerCorrelationRule null ` -BeforeProvisioningRule null ` - -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` - -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` + -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` + -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` -Type Multi-Host - Microsoft SQL Server ` -Connector multihost-microsoft-sql-server ` -ConnectorClass sailpoint.connector.OpenConnectorAdapter ` - -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` + -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` -DeleteThreshold 10 ` -Authoritative false ` -ManagementWorkgroup null ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NameNormalizer.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NameNormalizer.md index fce2af718de0..0b1b7e4d29ce 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NameNormalizer.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NameNormalizer.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $NameNormalizer = Initialize-PSSailpoint.BetaNameNormalizer -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRecord.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRecord.md index 47d0c49e28fc..aa389e307189 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRecord.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRecord.md @@ -42,7 +42,7 @@ $NonEmployeeRecord = Initialize-PSSailpoint.BetaNonEmployeeRecord -Id ac10e21c- -Phone 5125555555 ` -Manager jane.doe ` -SourceId 2c91808568c529c60168cca6f90c1313 ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -StartDate 2019-08-23T18:52:59.162Z ` -EndDate 2020-08-23T18:52:59.162Z ` -Modified 2019-08-23T18:52:59.162Z ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequest.md index 6ad6d12d1b1a..c940a60f8512 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequest.md @@ -52,7 +52,7 @@ $NonEmployeeRequest = Initialize-PSSailpoint.BetaNonEmployeeRequest -Id a030368 -Phone 5125555555 ` -Manager jane.doe ` -NonEmployeeSource null ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -ApprovalItems null ` -ApprovalStatus null ` -Comment approved ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestBody.md index 06237a1779e7..2a1dd278c264 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestBody.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestBody.md @@ -38,7 +38,7 @@ $NonEmployeeRequestBody = Initialize-PSSailpoint.BetaNonEmployeeRequestBody -Ac -Phone 5125555555 ` -Manager jane.doe ` -SourceId 2c91808568c529c60168cca6f90c1313 ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -StartDate 2020-03-24T00:00-05:00 ` -EndDate 2021-03-25T00:00-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index a90225ed7526..4eef8010323f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -47,12 +47,12 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR -Phone 5125555555 ` -Manager jane.doe ` -NonEmployeeSource null ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -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/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeSourceWithNECount.md index e6e843328deb..c09833c8a162 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeSourceWithNECount.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeSourceWithNECount.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes **AccountManagers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] **Modified** | **System.DateTime** | When the request was last modified. | [optional] **Created** | **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. This value is 'null' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] +**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NotificationTemplateContext.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NotificationTemplateContext.md index b100e3b946d9..5dfd044034bc 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NotificationTemplateContext.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NotificationTemplateContext.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$NotificationTemplateContext = Initialize-PSSailpoint.BetaNotificationTemplateContext -Attributes {productUrl=https://test-org.identitysoon.com, brandingConfigs={default={narrowLogoURL=null, productName=SailPoint, standardLogoURL=null, navigationColor=011E64, actionButtonColor=20B2DE, emailFromAddress=null, activeLinkColor=20B2DE, loginInformationalMessage=null}}} ` +$NotificationTemplateContext = Initialize-PSSailpoint.BetaNotificationTemplateContext -Attributes {productUrl=https://test-org.identitysoon.com, brandingConfigs={default={narrowLogoURL=null, productName=SailPoint, standardLogoURL=null, navigationColor=011E64, actionButtonColor=20B2DE, emailFromAddress=null, activeLinkColor=20B2DE, loginInformationalMessage=null}}} ` -Created 2020-04-15T16:16:47.525Z ` -Modified 2020-04-15T16:16:47.525Z ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/OrgConfig.md b/docs/tools/sdk/powershell/Reference/Beta/Models/OrgConfig.md index 4f535181c357..ed538793d255 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/OrgConfig.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/OrgConfig.md @@ -35,8 +35,8 @@ $OrgConfig = Initialize-PSSailpoint.BetaOrgConfig -OrgName acme-solar ` -TimeZone America/Toronto ` -LcsChangeHonorsSourceEnableFeature false ` -ArmCustomerId DE38E75A-5FF6-4A65-5DC7-08D64426B09E ` - -ArmSapSystemIdMappings [{sourceId=2c91808c791a94e501792388b0d62659, systemId=1556}, {sourceId=2_2c91808c791a94e501792388b0d62659, systemId=2_1556}, {sourceId=3_2c91808c791a94e501792388b0d62659, systemId=3_1556}] ` - -ArmAuth epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag== ` + -ArmSapSystemIdMappings [{sourceId=2c91808c791a94e501792388b0d62659, systemId=1556}, {sourceId=2_2c91808c791a94e501792388b0d62659, systemId=2_1556}, {sourceId=3_2c91808c791a94e501792388b0d62659, systemId=3_1556}] ` + -ArmAuth epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag== ` -ArmDb EU ` -ArmSsoUrl https://your-arm-sso-url ` -IaiEnableCertificationRecommendations true ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Outlier.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Outlier.md index 7b20e299a53c..98d2033940c4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Outlier.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Outlier.md @@ -38,7 +38,7 @@ $Outlier = Initialize-PSSailpoint.BetaOutlier -Id 5be33d3e-c54d-4ed7-af73-23805 -FirstDetectionDate 2021-05-01T18:40:35.772Z ` -LatestDetectionDate 2021-05-03T18:40:35.772Z ` -Ignored false ` - -Attributes {displayName=John Smith, jobTitle=Software Engineer, department=Engineering} ` + -Attributes {displayName=John Smith, jobTitle=Software Engineer, department=Engineering} ` -Score 0.92 ` -UnignoreType MANUAL ` -UnignoreDate 2021-06-01T18:40:35.772Z ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/OutlierFeatureSummary.md b/docs/tools/sdk/powershell/Reference/Beta/Models/OutlierFeatureSummary.md index 7c497efe2638..236d22ddbdd7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/OutlierFeatureSummary.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/OutlierFeatureSummary.md @@ -36,7 +36,7 @@ $OutlierFeatureSummary = Initialize-PSSailpoint.BetaOutlierFeatureSummary -Cont -FeatureExplanation An identity that has too much rare access has a higher change of becoming a security threat due to the unique access they possess ` -PeerDisplayName Mary Jane ` -PeerIdentityId 9f9d5d53ad0e48fba7352f6da9f1b8gbg ` - -AccessItemReference {displayName=All Rare Entitlements, searchPlaceholder=Search by name or description} + -AccessItemReference {displayName=All Rare Entitlements, searchPlaceholder=Search by name or description} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/PasswordChangeRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/PasswordChangeRequest.md index 1eff39dcd6d5..4b5b75cb35d4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/PasswordChangeRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/PasswordChangeRequest.md @@ -27,9 +27,9 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $PasswordChangeRequest = Initialize-PSSailpoint.BetaPasswordChangeRequest -IdentityId 8a807d4c73c545510173c545f0a002ff ` - -EncryptedPassword XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== ` + -EncryptedPassword XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== ` -PublicKeyId YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 ` - -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -SourceId 8a807d4c73c545510173c545d4b60246 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/PasswordInfoAccount.md b/docs/tools/sdk/powershell/Reference/Beta/Models/PasswordInfoAccount.md index aaca0ec7f201..d8db462c602e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/PasswordInfoAccount.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/PasswordInfoAccount.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$PasswordInfoAccount = Initialize-PSSailpoint.BetaPasswordInfoAccount -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` +$PasswordInfoAccount = Initialize-PSSailpoint.BetaPasswordInfoAccount -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -AccountName Abby.Smith ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/PostExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/PostExternalExecuteWorkflowRequest.md index 7307dc729b73..e2f750d59917 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/PostExternalExecuteWorkflowRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/PostExternalExecuteWorkflowRequest.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$PostExternalExecuteWorkflowRequest = Initialize-PSSailpoint.BetaPostExternalExecuteWorkflowRequest -VarInput {customAttribute1=value1, customAttribute2=value2} +$PostExternalExecuteWorkflowRequest = Initialize-PSSailpoint.BetaPostExternalExecuteWorkflowRequest -VarInput {customAttribute1=value1, customAttribute2=value2} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/PreviewDataSourceResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/PreviewDataSourceResponse.md index e8b30de826ae..bd224aed11a8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/PreviewDataSourceResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/PreviewDataSourceResponse.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$PreviewDataSourceResponse = Initialize-PSSailpoint.BetaPreviewDataSourceResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} +$PreviewDataSourceResponse = Initialize-PSSailpoint.BetaPreviewDataSourceResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Product.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Product.md index 8b7057fce4f7..585720087225 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Product.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Product.md @@ -44,7 +44,7 @@ $Product = Initialize-PSSailpoint.BetaProduct -ProductName idn ` -ProductRight idn:ui:view ` -ApiUrl https://tenant-name.api.identitynow.com ` -Licenses null ` - -Attributes {domain=https://tenant-name.identitynow.com, maxRegisteredUsers=250} ` + -Attributes {domain=https://tenant-name.identitynow.com, maxRegisteredUsers=250} ` -Zone Deployment zone for the Product ` -Status active ` -StatusDateTime 2020-05-19T13:49:37.385Z ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md index 61fda3f84625..accb840cb901 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ProvisioningCompletedAccountRequestsInner = Initialize-PSSailpoint.BetaProvisioningCompletedAccountRequestsInner -Source null ` - -AccountId CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com ` + -AccountId CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com ` -AccountOperation Modify ` -ProvisioningResult SUCCESS ` -ProvisioningTarget Corp AD ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md index 56ae1b0867d6..f27c6cefb5ca 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner = Initialize-PSSailpoint.BetaProvisioningCompletedAccountRequestsInnerAttributeRequestsInner -AttributeName memberOf ` - -AttributeValue CN=jedi,DC=starwars,DC=com ` + -AttributeValue CN=jedi,DC=starwars,DC=com ` -Operation Add ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningConfig.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningConfig.md index 46d14e2743db..03b9cba761c0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningConfig.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningConfig.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ProvisioningConfig = Initialize-PSSailpoint.BetaProvisioningConfig -UniversalManager true ` - -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` + -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` -PlanInitializerScript null ` -NoProvisioningRequests true ` -ProvisioningRequestExpiration 7 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningConfigPlanInitializerScript.md index 0cf7eeb29031..fda4b8ccbb63 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningConfigPlanInitializerScript.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningConfigPlanInitializerScript.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ProvisioningConfigPlanInitializerScript = Initialize-PSSailpoint.BetaProvisioningConfigPlanInitializerScript -Source <?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source> +$ProvisioningConfigPlanInitializerScript = Initialize-PSSailpoint.BetaProvisioningConfigPlanInitializerScript -Source \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RandomAlphaNumeric.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RandomAlphaNumeric.md index d7d91480af08..5541309e18d0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RandomAlphaNumeric.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RandomAlphaNumeric.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $RandomAlphaNumeric = Initialize-PSSailpoint.BetaRandomAlphaNumeric -Length 10 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RandomNumeric.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RandomNumeric.md index f8fd28d4725c..94b01113347a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RandomNumeric.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RandomNumeric.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $RandomNumeric = Initialize-PSSailpoint.BetaRandomNumeric -Length 10 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RecommendationResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RecommendationResponse.md index d2284a4842d2..781537e6f549 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RecommendationResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RecommendationResponse.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $RecommendationResponse = Initialize-PSSailpoint.BetaRecommendationResponse -Request null ` -Recommendation true ` -Interpretations [75% of identities with the same department have this access. This information had a high impact on the overall score., 67% of identities with the same peer group have this access. This information had a low impact on the overall score., 42% of identities with the same location have this access. This information had a low impact on the overall score.] ` - -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] ` + -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] ` -RecommenderCalculations null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Reference.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Reference.md index c10aff58ce87..cb3266d15757 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Reference.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Reference.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $Reference = Initialize-PSSailpoint.BetaReference -Id Existing Transform ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Replace.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Replace.md index e13c08b4b666..60c567b6fbd8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Replace.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Replace.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $Replace = Initialize-PSSailpoint.BetaReplace -Regex [^a-zA-Z] ` -Replacement ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ReplaceAll.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ReplaceAll.md index d6dd0a2cc76f..a72182cd95aa 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ReplaceAll.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ReplaceAll.md @@ -24,9 +24,9 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ReplaceAll = Initialize-PSSailpoint.BetaReplaceAll -Table {-= , "=', ñ=n} ` +$ReplaceAll = Initialize-PSSailpoint.BetaReplaceAll -Table {-= , "=', ñ=n} ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemStatus.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemStatus.md index 231de23b0267..1e762ba259b9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemStatus.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemStatus.md @@ -68,7 +68,7 @@ $RequestedItemStatus = Initialize-PSSailpoint.BetaRequestedItemStatus -Name Acc -RemoveDate 2019-10-23T00:00Z ` -Cancelable true ` -AccessRequestId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` - -ClientMetadata {key1=value1, key2=value2} + -ClientMetadata {key1=value1, key2=value2} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ResourceBundleMessage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ResourceBundleMessage.md index 6c12a15ee356..481f06af9b07 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ResourceBundleMessage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ResourceBundleMessage.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ResourceBundleMessage = Initialize-PSSailpoint.BetaResourceBundleMessage -Key recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_LOW ` - -Format {0,,\"i18n hint: percentage\"}% of identities with the same {1,,\"i18n hint: name of category feature\"} have this access. This information had a low impact on the overall score. + -Format {0,,\"i18n hint: percentage\"}% of identities with the same {1,,\"i18n hint: name of category feature\"} have this access. This information had a low impact on the overall score. ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ResourceObject.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ResourceObject.md index 9dcc104cad49..a424c250d012 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ResourceObject.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ResourceObject.md @@ -35,7 +35,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ResourceObject = Initialize-PSSailpoint.BetaResourceObject -Instance null ` - -Identity CN=Aaron Carr,OU=test1,DC=test2,DC=test ` + -Identity CN=Aaron Carr,OU=test1,DC=test2,DC=test ` -Uuid {abf7bd9b-68b4-4d21-9b70-870c58ebf844} ` -PreviousIdentity null ` -Name Aaron Carr ` @@ -45,7 +45,7 @@ $ResourceObject = Initialize-PSSailpoint.BetaResourceObject -Instance null ` -Delete false ` -Remove false ` -Missing [missFieldOne, missFieldTwo] ` - -Attributes {telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr} ` + -Attributes {telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr} ` -FinalUpdate false ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RightPad.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RightPad.md index df67f7097d4e..6de8b947be0d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RightPad.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RightPad.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $RightPad = Initialize-PSSailpoint.BetaRightPad -Length 4 ` -Padding 0 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Role.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Role.md index b8357e0a8835..d68ab7144482 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Role.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Role.md @@ -48,7 +48,7 @@ $Role = Initialize-PSSailpoint.BetaRole -Id 2c918086749d78830174a1a40e121518 ` -AccessProfiles null ` -Entitlements null ` -Membership null ` - -LegacyMembershipInfo {type=IDENTITY_LIST} ` + -LegacyMembershipInfo {type=IDENTITY_LIST} ` -Enabled true ` -Requestable true ` -AccessRequestConfig null ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RoleAssignmentDto.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RoleAssignmentDto.md index 0306b946cf17..25a5595b6d9d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RoleAssignmentDto.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RoleAssignmentDto.md @@ -32,10 +32,10 @@ Name | Type | Description | Notes ```powershell $RoleAssignmentDto = Initialize-PSSailpoint.BetaRoleAssignmentDto -Id 1cbb0705b38c4226b1334eadd8874086 ` -Role null ` - -Comments I'm a new Engineer and need this role to do my work ` + -Comments I'm a new Engineer and need this role to do my work ` -AssignmentSource UI ` -Assigner null ` - -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` + -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` -AssignmentContext null ` -AccountTargets null ` -RemoveDate Wed Feb 14 10:58:42 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningIdentityDistribution.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningIdentityDistribution.md index def82e72e316..2c8b4332db62 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningIdentityDistribution.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningIdentityDistribution.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $RoleMiningIdentityDistribution = Initialize-PSSailpoint.BetaRoleMiningIdentityDistribution -AttributeName department ` - -Distribution [{attributeValue=NM Tier 3, count=6}] + -Distribution [{attributeValue=NM Tier 3, count=6}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningPotentialRoleApplication.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningPotentialRoleApplication.md index eb7a072684bd..8ba8ba03b036 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningPotentialRoleApplication.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningPotentialRoleApplication.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$RoleMiningPotentialRoleApplication = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleApplication -Id {id=2c9180877212632a017228d5a796292b} ` - -Name {name=Slack} +$RoleMiningPotentialRoleApplication = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleApplication -Id {id=2c9180877212632a017228d5a796292b} ` + -Name {name=Slack} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningPotentialRoleEntitlements.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningPotentialRoleEntitlements.md index 2997524c566f..7ca091d6af19 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningPotentialRoleEntitlements.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningPotentialRoleEntitlements.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$RoleMiningPotentialRoleEntitlements = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleEntitlements -Id {id=2c9180877212632a017228d5a796292c} ` - -Name {name=LauncherTest2} +$RoleMiningPotentialRoleEntitlements = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleEntitlements -Id {id=2c9180877212632a017228d5a796292c} ` + -Name {name=LauncherTest2} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningSessionScope.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningSessionScope.md index b40f155e1617..fbf21718b588 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningSessionScope.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RoleMiningSessionScope.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $RoleMiningSessionScope = Initialize-PSSailpoint.BetaRoleMiningSessionScope -IdentityIds [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42] ` -Criteria source.name:DataScienceDataset ` - -AttributeFilterCriteria {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}} + -AttributeFilterCriteria {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SavedSearchComplete.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SavedSearchComplete.md index dfe75c7d8df0..53f69f503b68 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SavedSearchComplete.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SavedSearchComplete.md @@ -34,7 +34,7 @@ $SavedSearchComplete = Initialize-PSSailpoint.BetaSavedSearchComplete -FileName -Query modified:[now-7y/d TO now] ` -SearchName Modified Activity ` -SearchResults null ` - -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc + -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Days.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Days.md index d113ce6871e0..a78ba1944eae 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Days.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Days.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Schedule1Days = Initialize-PSSailpoint.BetaSchedule1Days -ApplicationId 2c91808874ff91550175097daaec161c" ` +$Schedule1Days = Initialize-PSSailpoint.BetaSchedule1Days -ApplicationId 2c91808874ff91550175097daaec161c" ` -AccountMatchConfig null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Hours.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Hours.md index 3aa36d7ac397..cae008333b3c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Hours.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Hours.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Schedule1Hours = Initialize-PSSailpoint.BetaSchedule1Hours -ApplicationId 2c91808874ff91550175097daaec161c" ` +$Schedule1Hours = Initialize-PSSailpoint.BetaSchedule1Hours -ApplicationId 2c91808874ff91550175097daaec161c" ` -AccountMatchConfig null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Months.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Months.md index 84ba75e418c1..43cbcbb111f2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Months.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Schedule1Months.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Schedule1Months = Initialize-PSSailpoint.BetaSchedule1Months -ApplicationId 2c91808874ff91550175097daaec161c" ` +$Schedule1Months = Initialize-PSSailpoint.BetaSchedule1Months -ApplicationId 2c91808874ff91550175097daaec161c" ` -AccountMatchConfig null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md index 28bca5a11705..c51a86b842d6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md @@ -41,8 +41,8 @@ $Schema = Initialize-PSSailpoint.BetaSchema -Id 2c9180835d191a86015d28455b4a232 -HierarchyAttribute memberOf ` -IncludePermissions false ` -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` - -Configuration {groupMemberAttribute=member} ` - -Attributes [{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}] ` + -Configuration {groupMemberAttribute=member} ` + -Attributes [{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}] ` -Created 2019-12-24T22:32:58.104Z ` -Modified 2019-12-31T20:22:28.104Z ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SearchAttributeConfig.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchAttributeConfig.md index 14a7ab8ced81..2d67a97fcce5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SearchAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchAttributeConfig.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $SearchAttributeConfig = Initialize-PSSailpoint.BetaSearchAttributeConfig -Name newMailAttribute ` -DisplayName New Mail Attribute ` - -ApplicationAttributes {2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} + -ApplicationAttributes {2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Selector.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Selector.md index fbaa737b30a6..235082f42a73 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Selector.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Selector.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Selector = Initialize-PSSailpoint.BetaSelector -ApplicationId 2c91808874ff91550175097daaec161c" ` +$Selector = Initialize-PSSailpoint.BetaSelector -ApplicationId 2c91808874ff91550175097daaec161c" ` -AccountMatchConfig null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SelectorAccountMatchConfigMatchExpression.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SelectorAccountMatchConfigMatchExpression.md index 367518e2e455..743bcc567cef 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SelectorAccountMatchConfigMatchExpression.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SelectorAccountMatchConfigMatchExpression.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SelectorAccountMatchConfigMatchExpression = Initialize-PSSailpoint.BetaSelectorAccountMatchConfigMatchExpression -MatchTerms [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}] ` +$SelectorAccountMatchConfigMatchExpression = Initialize-PSSailpoint.BetaSelectorAccountMatchConfigMatchExpression -MatchTerms [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}] ` -And true ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ServiceDeskIntegrationDto.md index 7720d0406552..a1950436afca 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ServiceDeskIntegrationDto.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ServiceDeskIntegrationDto.md @@ -39,7 +39,7 @@ $ServiceDeskIntegrationDto = Initialize-PSSailpoint.BetaServiceDeskIntegrationDt -Cluster xyzzy999 ` -ManagedSources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` -ProvisioningConfig null ` - -Attributes {property=value, key=value} ` + -Attributes {property=value, key=value} ` -BeforeProvisioningRule null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SimIntegrationDetails.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SimIntegrationDetails.md index 9576d4e3f139..bae4515a4d4c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SimIntegrationDetails.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SimIntegrationDetails.md @@ -39,11 +39,11 @@ $SimIntegrationDetails = Initialize-PSSailpoint.BetaSimIntegrationDetails -Id i -Modified 2023-01-03T21:16:22.432Z ` -Description Integration description ` -Type ServiceNow Service Desk ` - -Attributes {"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"} ` + -Attributes {"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"} ` -Sources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` -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} ` + -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} ` -BeforeProvisioningRule null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SodPolicy.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SodPolicy.md index 77bb86996548..1f9ec8b3036f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SodPolicy.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SodPolicy.md @@ -47,7 +47,7 @@ $SodPolicy = Initialize-PSSailpoint.BetaSodPolicy -Id 0f11f2a4-7c94-4bf3-a2bd-7 -OwnerRef null ` -ExternalPolicyReference XYZ policy ` -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 ` + -CompensatingControls Have a manager review the transaction decisions for their "out of compliance" employee ` -CorrectionAdvice Based on the role of the employee, managers should remove access that is not required for their job function. ` -State ENFORCED ` -Tags [TAG1, TAG2] ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SodViolationCheckResult.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SodViolationCheckResult.md index 972281e34533..32e3067fdabc 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SodViolationCheckResult.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SodViolationCheckResult.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $SodViolationCheckResult = Initialize-PSSailpoint.BetaSodViolationCheckResult -Message null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -ViolationContexts null ` -ViolatedPolicies null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SodViolationCheckResult1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SodViolationCheckResult1.md index d0f4745fa75a..075071f14e9a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SodViolationCheckResult1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SodViolationCheckResult1.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $SodViolationCheckResult1 = Initialize-PSSailpoint.BetaSodViolationCheckResult1 -Message null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -ViolationContexts null ` -ViolatedPolicies null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Source.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Source.md index 3c5f888d4da3..354f087afd2e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Source.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Source.md @@ -62,13 +62,13 @@ $Source = Initialize-PSSailpoint.BetaSource -Id 2c91808568c529c60168cca6f90c132 -ManagerCorrelationMapping null ` -ManagerCorrelationRule null ` -BeforeProvisioningRule null ` - -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` - -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` + -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` + -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` -Type OpenLDAP - Direct ` -Connector active-directory ` -ConnectorClass sailpoint.connector.LDAPConnector ` - -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` + -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` -DeleteThreshold 10 ` -Authoritative false ` -ManagementWorkgroup null ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Source1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Source1.md index a3fa5bc0e3a3..46276fbe2f38 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Source1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Source1.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Source1 = Initialize-PSSailpoint.BetaSource1 -Type rule ` - -Properties {ruleType=IdentityAttribute, ruleName=Cloud Promote Identity Attribute} + -Properties {ruleType=IdentityAttribute, ruleName=Cloud Promote Identity Attribute} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountCreated.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountCreated.md index c6ac2648bedc..e74afca86829 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountCreated.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountCreated.md @@ -36,7 +36,7 @@ $SourceAccountCreated = Initialize-PSSailpoint.BetaSourceAccountCreated -Uuid b -SourceName Active Directory ` -IdentityId ee769173319b41d19ccec6c235423237b ` -IdentityName john.doe ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountDeleted.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountDeleted.md index bdbc14fb60db..1681a2cb26f7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountDeleted.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountDeleted.md @@ -36,7 +36,7 @@ $SourceAccountDeleted = Initialize-PSSailpoint.BetaSourceAccountDeleted -Uuid b -SourceName Active Directory ` -IdentityId ee769173319b41d19ccec6c235423237b ` -IdentityName john.doe ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountUpdated.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountUpdated.md index 40f0713f7ac8..59b819617df0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountUpdated.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAccountUpdated.md @@ -36,7 +36,7 @@ $SourceAccountUpdated = Initialize-PSSailpoint.BetaSourceAccountUpdated -Uuid b -SourceName Active Directory ` -IdentityId ee769173319b41d19ccec6c235423237b ` -IdentityName john.doe ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAppAccountSource.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAppAccountSource.md index 8d87a913f190..a54cd73ab516 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAppAccountSource.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAppAccountSource.md @@ -30,7 +30,7 @@ $SourceAppAccountSource = Initialize-PSSailpoint.BetaSourceAppAccountSource -Id -Type SOURCE ` -Name ODS-AD-Source ` -UseForPasswordManagement false ` - -PasswordPolicies [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}] + -PasswordPolicies [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAppBulkUpdateRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAppBulkUpdateRequest.md index 6f24e04971bb..6eb754f22212 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAppBulkUpdateRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceAppBulkUpdateRequest.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $SourceAppBulkUpdateRequest = Initialize-PSSailpoint.BetaSourceAppBulkUpdateRequest -AppIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] ` - -JsonPatch [{op=replace, path=/enabled, value=false}, {op=replace, path=/matchAllAccounts, value=false}] + -JsonPatch [{op=replace, path=/enabled, value=false}, {op=replace, path=/matchAllAccounts, value=false}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceCode.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceCode.md index 4892da319282..932f2dc859f7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceCode.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceCode.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $SourceCode = Initialize-PSSailpoint.BetaSourceCode -Version 1.0 ` - -Script return "Mr. " + firstName; + -Script return "Mr. " + firstName; ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceCreationErrors.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceCreationErrors.md index 3112937b69e6..9d9fb189ef93 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceCreationErrors.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceCreationErrors.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes ```powershell $SourceCreationErrors = Initialize-PSSailpoint.BetaSourceCreationErrors -MultihostId 2c91808568c529c60168cca6f90c1324 ` -SourceName My Source ` - -SourceError Source with internal name "My Source [source]" already exists. ` + -SourceError Source with internal name "My Source [source]" already exists. ` -Created 2022-02-08T14:50:03.827Z ` -Modified 2024-01-23T18:08:50.897Z ` -Operation DELETE diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceSyncPayload.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceSyncPayload.md index b7fe01665cfe..f706940546c9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceSyncPayload.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceSyncPayload.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $SourceSyncPayload = Initialize-PSSailpoint.BetaSourceSyncPayload -Type SYNCHRONIZE_SOURCE_ATTRIBUTES ` - -DataJson {"sourceId":"2c918083746f642c01746f990884012a"} + -DataJson {"sourceId":"2c918083746f642c01746f990884012a"} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md index 05cceab03379..bb3b653839f5 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/SpConfigImportResults.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigImportResults.md index 88579665b571..0affef7193f6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigImportResults.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigImportResults.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SpConfigImportResults = Initialize-PSSailpoint.BetaSpConfigImportResults -Results {results={TRIGGER_SUBSCRIPTION={infos=[{key=IMPORT_PREVIEW, text=Object to be imported: [c953134c-2224-42f2-a84e-fa5cbb395904, Test 2], detail=null}, {key=IMPORT_PREVIEW, text=Object to be imported: [be9e116d-08e1-49fc-ab7f-fa585e96c9e4, Test 1], detail=null}], warnings=[], errors=[], importedObjects=[]}}} ` +$SpConfigImportResults = Initialize-PSSailpoint.BetaSpConfigImportResults -Results {results={TRIGGER_SUBSCRIPTION={infos=[{key=IMPORT_PREVIEW, text=Object to be imported: [c953134c-2224-42f2-a84e-fa5cbb395904, Test 2], detail=null}, {key=IMPORT_PREVIEW, text=Object to be imported: [be9e116d-08e1-49fc-ab7f-fa585e96c9e4, Test 1], detail=null}], warnings=[], errors=[], importedObjects=[]}}} ` -ExportJobId be9e116d-08e1-49fc-ab7f-fa585e96c9e4 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigMessage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigMessage.md index 0f83b381f3fb..358921c5541b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigMessage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigMessage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $SpConfigMessage = Initialize-PSSailpoint.BetaSpConfigMessage -Key UNKNOWN_REFERENCE_RESOLVER ` -Text Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity] ` - -Details {details=message details} + -Details {details=message details} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md index d0dfc3176dba..0acc1f6212f5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigObject.md @@ -19,7 +19,6 @@ Name | Type | Description | Notes **ObjectType** | **String** | The object type this configuration is for. | [optional] **ReferenceExtractors** | **[]String** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] **SignatureRequired** | **Boolean** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false] -**AlwaysResolveById** | **Boolean** | Whether this object type has to be resolved always by ID | [optional] [default to $false] **LegacyObject** | **Boolean** | Whether this is a legacy object | [optional] [default to $false] **OnePerTenant** | **Boolean** | Whether there is only one object of this type | [optional] [default to $false] **Exportable** | **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false] @@ -32,7 +31,6 @@ Name | Type | Description | Notes $SpConfigObject = Initialize-PSSailpoint.BetaSpConfigObject -ObjectType TRIGGER_SUBSCRIPTION ` -ReferenceExtractors [$.owner] ` -SignatureRequired false ` - -AlwaysResolveById true ` -LegacyObject false ` -OnePerTenant false ` -Exportable true ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md index 61e9a11135d7..843212093beb 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRule.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'BetaSpConfigRule'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Path** | **String** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] -**Value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional] -**Modes** | **[]String** | Draft modes to which this rule will apply | [optional] +**Value** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value to be assigned at the jsonPath location within the object | [optional] +**Mode** | **[]String** | Draft modes to which this rule will apply | [optional] ## Examples @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $SpConfigRule = Initialize-PSSailpoint.BetaSpConfigRule -Path $.enabled ` -Value null ` - -Modes [RESTORE, PROMOTE] + -Mode [RESTORE, PROMOTE] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRuleValue.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRuleValue.md deleted file mode 100644 index 212c5c347368..000000000000 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SpConfigRuleValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: beta-sp-config-rule-value -title: SpConfigRuleValue -pagination_label: SpConfigRuleValue -sidebar_label: SpConfigRuleValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRuleValue', 'BetaSpConfigRuleValue'] -slug: /tools/sdk/powershell/beta/models/sp-config-rule-value -tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'BetaSpConfigRuleValue'] ---- - - -# SpConfigRuleValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$SpConfigRuleValue = Initialize-PSSailpoint.BetaSpConfigRuleValue -``` - -- Convert the resource to JSON -```powershell -$SpConfigRuleValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Split.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Split.md index 43175c38df30..03fa3ad039b0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Split.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Split.md @@ -30,7 +30,7 @@ $Split = Initialize-PSSailpoint.BetaSplit -Delimiter , ` -Index 5 ` -Throws true ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/StartInvocationInput.md b/docs/tools/sdk/powershell/Reference/Beta/Models/StartInvocationInput.md index b1af5c883864..76c9edfd28fb 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/StartInvocationInput.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/StartInvocationInput.md @@ -25,8 +25,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $StartInvocationInput = Initialize-PSSailpoint.BetaStartInvocationInput -TriggerId idn:access-requested ` - -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` - -ContentJson {workflowId=1234} + -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -ContentJson {workflowId=1234} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/StatusResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/StatusResponse.md index abc7ee6c2fe8..440feb91b55b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/StatusResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/StatusResponse.md @@ -30,7 +30,7 @@ $StatusResponse = Initialize-PSSailpoint.BetaStatusResponse -Id 2c91808568c529c -Name ODS-AD-Test [source-999999] ` -Status SUCCESS ` -ElapsedMillis 1000 ` - -Details {useTLSForIQService=false, IQService={TLS Port=0, .NET CLR Version=4.0.30319.42000, SecondaryServiceStatus=Running, Port=5050, Host=AUTOMATION-AD, Name=IQService, IQServiceStatus=Running, SecondaryService=IQService-Instance1-Secondary, Version=IQService Sep-2020, secondaryPort=5051, OS Architecture=AMD64, Operating System=Microsoft Windows Server 2012 R2 Standard, highestDotNetVersion=4.8 or later, Build Time=09/22/2020 06:34 AM -0500}, IQServiceClientAuthEnabled=false, requestProcessedOn=1/19/2021 1:47:14 PM} + -Details {useTLSForIQService=false, IQService={TLS Port=0, .NET CLR Version=4.0.30319.42000, SecondaryServiceStatus=Running, Port=5050, Host=AUTOMATION-AD, Name=IQService, IQServiceStatus=Running, SecondaryService=IQService-Instance1-Secondary, Version=IQService Sep-2020, secondaryPort=5051, OS Architecture=AMD64, Operating System=Microsoft Windows Server 2012 R2 Standard, highestDotNetVersion=4.8 or later, Build Time=09/22/2020 06:34 AM -0500}, IQServiceClientAuthEnabled=false, requestProcessedOn=1/19/2021 1:47:14 PM} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Subscription.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Subscription.md index 0e697005d695..f9ee7b8b0114 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Subscription.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Subscription.md @@ -42,7 +42,7 @@ $Subscription = Initialize-PSSailpoint.BetaSubscription -Id 0f11f2a4-7c94-4bf3- -HttpConfig null ` -EventBridgeConfig null ` -Enabled true ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SubscriptionPostRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SubscriptionPostRequest.md index 9e1bb157fa2c..525b4390c10b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SubscriptionPostRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SubscriptionPostRequest.md @@ -38,7 +38,7 @@ $SubscriptionPostRequest = Initialize-PSSailpoint.BetaSubscriptionPostRequest - -HttpConfig null ` -EventBridgeConfig null ` -Enabled true ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SubscriptionPutRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SubscriptionPutRequest.md index 3a0d8c5dde5c..3be425b8fb15 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SubscriptionPutRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SubscriptionPutRequest.md @@ -36,7 +36,7 @@ $SubscriptionPutRequest = Initialize-PSSailpoint.BetaSubscriptionPutRequest -Na -HttpConfig null ` -EventBridgeConfig null ` -Enabled true ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Substring.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Substring.md index b087c657ad77..9ddfc8958f7d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Substring.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Substring.md @@ -32,7 +32,7 @@ $Substring = Initialize-PSSailpoint.BetaSubstring -VarBegin 1 ` -VarEnd 6 ` -EndOffset 1 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TagTagCategoryRefsInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TagTagCategoryRefsInner.md index 6835c498d1a3..681da8a934f4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TagTagCategoryRefsInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TagTagCategoryRefsInner.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $TagTagCategoryRefsInner = Initialize-PSSailpoint.BetaTagTagCategoryRefsInner -Type ENTITLEMENT ` -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TaskStatus.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TaskStatus.md index 015e33364781..4d739cfa3184 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TaskStatus.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TaskStatus.md @@ -53,7 +53,7 @@ $TaskStatus = Initialize-PSSailpoint.BetaTaskStatus -Id id12345 ` -CompletionStatus SUCCESS ` -Messages null ` -Returns null ` - -Attributes {identityCount=0} ` + -Attributes {identityCount=0} ` -Progress Started ` -PercentComplete 100 ` -TaskDefinitionSummary null diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TaskStatusMessage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TaskStatusMessage.md index 6a75f2d807d6..0ca20cdf83cd 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TaskStatusMessage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TaskStatusMessage.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $TaskStatusMessage = Initialize-PSSailpoint.BetaTaskStatusMessage -Type INFO ` -LocalizedText null ` -Key akey ` - -Parameters [{name=value}] + -Parameters [{name=value}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TemplateDto.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TemplateDto.md index 2e4a5f726404..512a886b173a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TemplateDto.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TemplateDto.md @@ -47,7 +47,7 @@ $TemplateDto = Initialize-PSSailpoint.BetaTemplateDto -Key cloud_manual_work_it -Footer null ` -VarFrom $__global.emailFromAddress ` -ReplyTo $__global.emailFromAddress ` - -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` + -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` -Id c17bea3a-574d-453c-9e04-4365fbf5af0b ` -Created 2020-01-01T00:00Z ` -Modified 2020-01-01T00:00Z ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TemplateDtoDefault.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TemplateDtoDefault.md index 7c76eca25fde..a7fe93fc586f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TemplateDtoDefault.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TemplateDtoDefault.md @@ -44,7 +44,7 @@ $TemplateDtoDefault = Initialize-PSSailpoint.BetaTemplateDtoDefault -Key cloud_ -Footer null ` -VarFrom $__global.emailFromAddress ` -ReplyTo $__global.emailFromAddress ` - -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` + -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` -SlackTemplate null ` -TeamsTemplate null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TestExternalExecuteWorkflow200Response.md index 2bf45d876311..b9432842196b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TestExternalExecuteWorkflow200Response.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TestExternalExecuteWorkflow200Response.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$TestExternalExecuteWorkflow200Response = Initialize-PSSailpoint.BetaTestExternalExecuteWorkflow200Response -Payload {test=hello world} +$TestExternalExecuteWorkflow200Response = Initialize-PSSailpoint.BetaTestExternalExecuteWorkflow200Response -Payload {test=hello world} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TestExternalExecuteWorkflowRequest.md index db0a60e62314..fb3005fdb98f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TestExternalExecuteWorkflowRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TestExternalExecuteWorkflowRequest.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$TestExternalExecuteWorkflowRequest = Initialize-PSSailpoint.BetaTestExternalExecuteWorkflowRequest -VarInput {test=hello world} +$TestExternalExecuteWorkflowRequest = Initialize-PSSailpoint.BetaTestExternalExecuteWorkflowRequest -VarInput {test=hello world} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TestInvocation.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TestInvocation.md index a1af6c05df67..ea8ae512d730 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TestInvocation.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TestInvocation.md @@ -26,8 +26,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $TestInvocation = Initialize-PSSailpoint.BetaTestInvocation -TriggerId idn:access-request-post-approval ` - -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` - -ContentJson {workflowId=1234} ` + -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -ContentJson {workflowId=1234} ` -SubscriptionIds [0f11f2a4-7c94-4bf3-a2bd-742580fe3bde] ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformAttributes.md index e6bf56cf3ba1..5171c3ecc9d0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformAttributes.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformAttributes.md @@ -67,10 +67,10 @@ $TransformAttributes = Initialize-PSSailpoint.BetaTransformAttributes -SourceNa -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` -Values string$variable ` -Expression now+1w ` -PositiveCondition true ` @@ -92,7 +92,7 @@ $TransformAttributes = Initialize-PSSailpoint.BetaTransformAttributes -SourceNa -Substring admin_ ` -Format alpha2 ` -Padding 0 ` - -Table {-= , "=', ñ=n} ` + -Table {-= , "=', ñ=n} ` -Id Existing Transform ` -Regex [^a-zA-Z] ` -Replacement ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md index 9ec77c52cfd5..fb6a5960165b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'BetaTransformD Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | Transform definition type. | [optional] +**Type** | **String** | The type of the transform definition. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $TransformDefinition = Initialize-PSSailpoint.BetaTransformDefinition -Type accountAttribute ` - -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} + -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md index 85749196fb85..440d0b3892ae 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition1', 'BetaTransform Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | Transform definition type. | [optional] +**Type** | **String** | The type of the transform definition. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $TransformDefinition1 = Initialize-PSSailpoint.BetaTransformDefinition1 -Type accountAttribute ` - -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} + -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Trigger.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Trigger.md index 70cdb6e93737..661ef6b9a5ef 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Trigger.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Trigger.md @@ -33,9 +33,9 @@ $Trigger = Initialize-PSSailpoint.BetaTrigger -Id idn:access-request-dynamic-ap -Name Access Request Dynamic Approver ` -Type null ` -Description Trigger for getting a dynamic approver. ` - -InputSchema {"definitions":{"record:AccessRequestDynamicApproverInput":{"type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"additionalProperties":true,"properties":{"accessRequestId":{"type":"string"},"requestedFor":{"$ref":"#/definitions/record:requestedForIdentityRef"},"requestedItems":{"type":"array","items":{"$ref":"#/definitions/record:requestedObjectRef"}},"requestedBy":{"$ref":"#/definitions/record:requestedByIdentityRef"}}},"record:requestedForIdentityRef":{"type":"object","required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"record:requestedObjectRef":{"type":"object","optional":["description","comment"],"required":["id","name","type","operation"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"oneOf":[{"type":"null"},{"type":"string"}]},"type":{"type":"string"},"operation":{"type":"string"},"comment":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"record:requestedByIdentityRef":{"type":"object","required":["type","id","name"],"additionalProperties":true,"properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverInput"} ` + -InputSchema {"definitions":{"record:AccessRequestDynamicApproverInput":{"type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"additionalProperties":true,"properties":{"accessRequestId":{"type":"string"},"requestedFor":{"$ref":"#/definitions/record:requestedForIdentityRef"},"requestedItems":{"type":"array","items":{"$ref":"#/definitions/record:requestedObjectRef"}},"requestedBy":{"$ref":"#/definitions/record:requestedByIdentityRef"}}},"record:requestedForIdentityRef":{"type":"object","required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"record:requestedObjectRef":{"type":"object","optional":["description","comment"],"required":["id","name","type","operation"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"oneOf":[{"type":"null"},{"type":"string"}]},"type":{"type":"string"},"operation":{"type":"string"},"comment":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"record:requestedByIdentityRef":{"type":"object","required":["type","id","name"],"additionalProperties":true,"properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverInput"} ` -ExampleInput null ` - -OutputSchema {"definitions":{"record:AccessRequestDynamicApproverOutput":{"type":["null","object"],"required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverOutput"} ` + -OutputSchema {"definitions":{"record:AccessRequestDynamicApproverOutput":{"type":["null","object"],"required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverOutput"} ` -ExampleOutput null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TriggerExampleInput.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TriggerExampleInput.md index bb6e3ea54d4f..bb100bfc14f9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TriggerExampleInput.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TriggerExampleInput.md @@ -85,7 +85,7 @@ $TriggerExampleInput = Initialize-PSSailpoint.BetaTriggerExampleInput -AccessRe -Identity null ` -Account null ` -Changes null ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ` + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ` -EntitlementCount 0 ` -Campaign null ` -Certification null ` @@ -101,7 +101,7 @@ $TriggerExampleInput = Initialize-PSSailpoint.BetaTriggerExampleInput -AccessRe -Query modified:[now-7y/d TO now] ` -SearchName Modified Activity ` -SearchResults null ` - -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc ` + -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc ` -Uuid b7264868-7201-415f-9118-b581d431c688 ` -Id 2c9180866166b5b0016167c32ef31a66 ` -NativeIdentifier E009 ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Trim.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Trim.md index c08994c10fdd..e2adac6bdd32 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Trim.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Trim.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Trim = Initialize-PSSailpoint.BetaTrim -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Upper.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Upper.md index 9bf9e50e1201..b744f5e4251c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Upper.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Upper.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Upper = Initialize-PSSailpoint.BetaUpper -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/V3ConnectorDto.md b/docs/tools/sdk/powershell/Reference/Beta/Models/V3ConnectorDto.md index f63c5f1fb507..3818081a6462 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/V3ConnectorDto.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/V3ConnectorDto.md @@ -35,7 +35,7 @@ $V3ConnectorDto = Initialize-PSSailpoint.BetaV3ConnectorDto -Name name ` -ClassName sailpoint.connector.OpenConnectorAdapter ` -Features [PROVISIONING, SYNC_PROVISIONING, SEARCH, UNSTRUCTURED_TARGETS] ` -DirectConnect true ` - -ConnectorMetadata {supportedUI=EXTJS, platform=ccg, shortDesc=connector description} ` + -ConnectorMetadata {supportedUI=EXTJS, platform=ccg, shortDesc=connector description} ` -Status RELEASED ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ValidateFilterInputDto.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ValidateFilterInputDto.md index dc127e294ca6..296305de42df 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ValidateFilterInputDto.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ValidateFilterInputDto.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ValidateFilterInputDto = Initialize-PSSailpoint.BetaValidateFilterInputDto -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] +$ValidateFilterInputDto = Initialize-PSSailpoint.BetaValidateFilterInputDto -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkItemForward.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkItemForward.md index 7a75ccee3fed..69339e1af6f8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkItemForward.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkItemForward.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $WorkItemForward = Initialize-PSSailpoint.BetaWorkItemForward -TargetOwnerId 2c9180835d2e5168015d32f890ca1581 ` - -Comment I'm going on vacation. ` + -Comment I'm going on vacation. ` -SendNotifications true ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkItems.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkItems.md index 852c121592b9..584df6fde6fa 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkItems.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkItems.md @@ -45,7 +45,7 @@ $WorkItems = Initialize-PSSailpoint.BetaWorkItems -Id 2c9180835d2e5168015d32f89 -OwnerName Jason Smith ` -Created 2017-07-11T18:45:37.098Z ` -Modified 2018-06-25T20:22:28.104Z ` - -Description Create account on source 'AD' ` + -Description Create account on source 'AD' ` -State null ` -Type null ` -RemediationItems null ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Workflow.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Workflow.md index 78ff2b4454d2..c60014dd95da 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Workflow.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Workflow.md @@ -36,7 +36,7 @@ Name | Type | Description | Notes ```powershell $Workflow = Initialize-PSSailpoint.BetaWorkflow -Name Send Email ` -Owner null ` - -Description Send an email to the identity who's attributes changed. ` + -Description Send an email to the identity who's attributes changed. ` -Definition null ` -Enabled false ` -Trigger null ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowBody.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowBody.md index da5728a404e6..3e43f3cab048 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowBody.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowBody.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes ```powershell $WorkflowBody = Initialize-PSSailpoint.BetaWorkflowBody -Name Send Email ` -Owner null ` - -Description Send an email to the identity who's attributes changed. ` + -Description Send an email to the identity who's attributes changed. ` -Definition null ` -Enabled false ` -Trigger null diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowDefinition.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowDefinition.md index 4d2b4c16a1c9..4327887bb8c4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowDefinition.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowDefinition.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $WorkflowDefinition = Initialize-PSSailpoint.BetaWorkflowDefinition -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}} + -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}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md index 8e629a09c346..867c40b0d5e5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryAction.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryAction.md index f7fa639e3ef4..f3812e03fa4c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryAction.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryAction.md @@ -44,7 +44,7 @@ $WorkflowLibraryAction = Initialize-PSSailpoint.BetaWorkflowLibraryAction -Id s -VersionNumber null ` -IsSimulationEnabled null ` -IsDynamicSchema false ` - -OutputSchema {definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} + -OutputSchema {definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryOperator.md index b04b1d51d71c..c831567cd291 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryOperator.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryOperator.md @@ -38,7 +38,7 @@ $WorkflowLibraryOperator = Initialize-PSSailpoint.BetaWorkflowLibraryOperator - -Deprecated null ` -DeprecatedBy null ` -IsSimulationEnabled null ` - -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryTrigger.md index 093a8aa592a6..32640f409fec 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryTrigger.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowLibraryTrigger.md @@ -41,7 +41,7 @@ $WorkflowLibraryTrigger = Initialize-PSSailpoint.BetaWorkflowLibraryTrigger -Id -Name Identity Attributes Changed ` -Description One or more identity attributes changed. ` -IsDynamicSchema false ` - -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ` + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ` -FormFields [] ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowTriggerAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowTriggerAttributes.md index b5df78e13c88..26bf522c58c9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowTriggerAttributes.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowTriggerAttributes.md @@ -33,7 +33,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $WorkflowTriggerAttributes = Initialize-PSSailpoint.BetaWorkflowTriggerAttributes -Id idn:identity-attributes-changed ` - -VarFilter $.changes[?(@.attribute == 'manager')] ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` -Description Run a search and notify the results ` -Name search-and-notify ` -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupDeleteItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupDeleteItem.md index 3967a13a851a..608a467a7b96 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupDeleteItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupDeleteItem.md @@ -27,11 +27,11 @@ Name | Type | Description | Notes $WorkgroupDeleteItem = Initialize-PSSailpoint.BetaWorkgroupDeleteItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` -Status 204 ` -Description -> Governance Group deleted successfully. +> Governance Group deleted successfully. -> Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use. +> Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use. -> Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found. +> Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found. ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupMemberAddItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupMemberAddItem.md index d881b089f570..2dbada1ce0d8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupMemberAddItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupMemberAddItem.md @@ -27,9 +27,9 @@ Name | Type | Description | Notes $WorkgroupMemberAddItem = Initialize-PSSailpoint.BetaWorkgroupMemberAddItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` -Status 201 ` -Description -> Identity is added into Governance Group members list. +> Identity is added into Governance Group members list. -> Unable to set Membership of Identity "3244d5f2d04447498520f54c6789ae33" to Governance Group "f80bba83-98c4-4ec2-81c8-373c00e9663b"; the relationship already exists. +> Unable to set Membership of Identity "3244d5f2d04447498520f54c6789ae33" to Governance Group "f80bba83-98c4-4ec2-81c8-373c00e9663b"; the relationship already exists. ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupMemberDeleteItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupMemberDeleteItem.md index a5d97cf3b99f..4eebca81f7e5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupMemberDeleteItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkgroupMemberDeleteItem.md @@ -27,9 +27,9 @@ Name | Type | Description | Notes $WorkgroupMemberDeleteItem = Initialize-PSSailpoint.BetaWorkgroupMemberDeleteItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` -Status 204 ` -Description -> Identity deleted from Governance Group members list. +> Identity deleted from Governance Group members list. -> Referenced Governance Group Member with Identity Id "bc3a744678534eb78a8002ee2085df64" was not found. +> Referenced Governance Group Member with Identity Id "bc3a744678534eb78a8002ee2085df64" was not found. ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md index b18cda213e38..d35d5b3d013e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md @@ -182,10 +182,10 @@ $AccessProfile = @"{ try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-V2024AccessProfile -V2024AccessProfile $Result + New-V2024AccessProfile -AccessProfile $Result # Below is a request that includes all optional parameters - # New-V2024AccessProfile -V2024AccessProfile $Result + # New-V2024AccessProfile -AccessProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessProfile" Write-Host $_.ErrorDetails @@ -285,10 +285,10 @@ $AccessProfileBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $Result + Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $Result + # Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesInBulk" Write-Host $_.ErrorDetails @@ -529,10 +529,10 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AccessProfile -Id $Id -V2024JsonPatchOperation $Result + Update-V2024AccessProfile -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024AccessProfile -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024AccessProfile -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfile" Write-Host $_.ErrorDetails @@ -588,10 +588,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner - Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result + Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result + # Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $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 45e0ad2cdb8d..8a803a23d6a1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md @@ -91,7 +91,7 @@ try { Approve-V2024AccessRequest -ApprovalId $ApprovalId # Below is a request that includes all optional parameters - # Approve-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result + # Approve-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024AccessRequest" Write-Host $_.ErrorDetails @@ -140,10 +140,10 @@ $ForwardApprovalDto = @"{ try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result + Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result # Below is a request that includes all optional parameters - # Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result + # Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardAccessRequest" Write-Host $_.ErrorDetails @@ -407,10 +407,10 @@ $CommentDto = @"{ try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result + Deny-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result # Below is a request that includes all optional parameters - # Deny-V2024AccessRequest -ApprovalId $ApprovalId -V2024CommentDto $Result + # Deny-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $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 aeb2ba634de9..37ff66bfba47 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestIdentityMetricsApi.md @@ -25,6 +25,9 @@ Method | HTTP request | Description ## 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) @@ -35,6 +38,7 @@ Param Type | Name | Data Type | Required | Description Path | IdentityId | **String** | True | Manager's identity ID. Path | RequestedObjectId | **String** | True | Requested access item's ID. Path | Type | **String** | True | Requested access item's type. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) @@ -58,14 +62,15 @@ Code | Description | Data Type $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. $Type = "ENTITLEMENT" # String | Requested access item's type. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Return access request identity metrics try { - Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + # 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 86aa2692702c..40b8a622734f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md @@ -82,10 +82,10 @@ $BulkApproveAccessRequest = @"{ try { $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest - Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $Result + Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result # Below is a request that includes all optional parameters - # Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $Result + # Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024BulkAccessRequest" Write-Host $_.ErrorDetails @@ -133,10 +133,10 @@ $CancelAccessRequest = @"{ try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-V2024AccessRequest -V2024CancelAccessRequest $Result + Suspend-V2024AccessRequest -CancelAccessRequest $Result # Below is a request that includes all optional parameters - # Suspend-V2024AccessRequest -V2024CancelAccessRequest $Result + # Suspend-V2024AccessRequest -CancelAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequest" Write-Host $_.ErrorDetails @@ -184,10 +184,10 @@ $BulkCancelAccessRequest = @"{ try { $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest - Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $Result + Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result # Below is a request that includes all optional parameters - # Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $Result + # Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequestInBulk" Write-Host $_.ErrorDetails @@ -251,10 +251,10 @@ $CloseAccessRequest = @"{ try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest - Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result + Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result # Below is a request that includes all optional parameters - # Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result + # Close-V2024AccessRequest -XSailPointExperimental $XSailPointExperimental -CloseAccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest" Write-Host $_.ErrorDetails @@ -380,10 +380,10 @@ $AccessRequest = @"{ try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-V2024AccessRequest -V2024AccessRequest $Result + New-V2024AccessRequest -AccessRequest $Result # Below is a request that includes all optional parameters - # New-V2024AccessRequest -V2024AccessRequest $Result + # New-V2024AccessRequest -AccessRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessRequest" Write-Host $_.ErrorDetails @@ -623,10 +623,10 @@ $AccessRequestConfig = @"{ try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-V2024AccessRequestConfig -V2024AccessRequestConfig $Result + Set-V2024AccessRequestConfig -AccessRequestConfig $Result # Below is a request that includes all optional parameters - # Set-V2024AccessRequestConfig -V2024AccessRequestConfig $Result + # Set-V2024AccessRequestConfig -AccessRequestConfig $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/V2024AccountsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md index 3bddb50b8ec5..176ee99adc5f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md @@ -117,10 +117,10 @@ $AccountAttributesCreate = @"{ try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-V2024Account -V2024AccountAttributesCreate $Result + New-V2024Account -AccountAttributesCreate $Result # Below is a request that includes all optional parameters - # New-V2024Account -V2024AccountAttributesCreate $Result + # New-V2024Account -AccountAttributesCreate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account" Write-Host $_.ErrorDetails @@ -274,10 +274,10 @@ $AccountToggleRequest = @"{ try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-V2024Account -Id $Id -V2024AccountToggleRequest $Result + Disable-V2024Account -Id $Id -AccountToggleRequest $Result # Below is a request that includes all optional parameters - # Disable-V2024Account -Id $Id -V2024AccountToggleRequest $Result + # Disable-V2024Account -Id $Id -AccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account" Write-Host $_.ErrorDetails @@ -378,10 +378,10 @@ $IdentitiesAccountsBulkRequest = @"{ try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters - # Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + # Disable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities" Write-Host $_.ErrorDetails @@ -430,10 +430,10 @@ $AccountToggleRequest = @"{ try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-V2024Account -Id $Id -V2024AccountToggleRequest $Result + Enable-V2024Account -Id $Id -AccountToggleRequest $Result # Below is a request that includes all optional parameters - # Enable-V2024Account -Id $Id -V2024AccountToggleRequest $Result + # Enable-V2024Account -Id $Id -AccountToggleRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account" Write-Host $_.ErrorDetails @@ -534,10 +534,10 @@ $IdentitiesAccountsBulkRequest = @"{ try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result # Below is a request that includes all optional parameters - # Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + # Enable-V2024AccountsForIdentities -XSailPointExperimental $XSailPointExperimental -IdentitiesAccountsBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities" Write-Host $_.ErrorDetails @@ -655,8 +655,8 @@ Param Type | Name | Data Type | Required | Description Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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 | DetailLevel | **String** | (optional) | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - 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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* + 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: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** ### Return type [**Account[]**](../models/account) @@ -681,8 +681,8 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $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) $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) -$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) +$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (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, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # Accounts List @@ -749,10 +749,10 @@ $AccountAttributes = @"{ try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-V2024Account -Id $Id -V2024AccountAttributes $Result + Send-V2024Account -Id $Id -AccountAttributes $Result # Below is a request that includes all optional parameters - # Send-V2024Account -Id $Id -V2024AccountAttributes $Result + # Send-V2024Account -Id $Id -AccountAttributes $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account" Write-Host $_.ErrorDetails @@ -849,10 +849,10 @@ $AccountUnlockRequest = @"{ try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-V2024Account -Id $Id -V2024AccountUnlockRequest $Result + Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result # Below is a request that includes all optional parameters - # Unlock-V2024Account -Id $Id -V2024AccountUnlockRequest $Result + # Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account" 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 9eb3cca4b627..5fa87d4556ab 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md @@ -84,10 +84,10 @@ $SourceAppCreateDto = @"{ try { $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto - New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result + New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result # Below is a request that includes all optional parameters - # New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result + # New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp" Write-Host $_.ErrorDetails @@ -702,7 +702,7 @@ try { Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + # Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp" Write-Host $_.ErrorDetails @@ -761,7 +761,7 @@ try { Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + # Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp" Write-Host $_.ErrorDetails @@ -825,7 +825,7 @@ try { Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -V2024SourceAppBulkUpdateRequest $Result + # Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $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 ac6417057904..2fd0f25d0451 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md @@ -175,10 +175,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + # Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $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 24e4f2ca28e3..cdc4b248ca12 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md @@ -119,10 +119,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AuthUser -Id $Id -V2024JsonPatchOperation $Result + Update-V2024AuthUser -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024AuthUser -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024AuthUser -Id $Id -JsonPatchOperation $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/V2024CertificationCampaignFiltersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md index 1957e65e9f9b..42505c69e135 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md @@ -103,10 +103,10 @@ $CampaignFilterDetails = @"{ try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - New-V2024CampaignFilter -V2024CampaignFilterDetails $Result + New-V2024CampaignFilter -CampaignFilterDetails $Result # Below is a request that includes all optional parameters - # New-V2024CampaignFilter -V2024CampaignFilterDetails $Result + # New-V2024CampaignFilter -CampaignFilterDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignFilter" Write-Host $_.ErrorDetails @@ -312,10 +312,10 @@ $CampaignFilterDetails = @"{ try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails - Update-V2024CampaignFilter -FilterId $FilterId -V2024CampaignFilterDetails $Result + Update-V2024CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result # Below is a request that includes all optional parameters - # Update-V2024CampaignFilter -FilterId $FilterId -V2024CampaignFilterDetails $Result + # Update-V2024CampaignFilter -FilterId $FilterId -CampaignFilterDetails $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 b7256af868ab..bd7c2a8e0624 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md @@ -158,7 +158,7 @@ try { Complete-V2024Campaign -Id $Id # Below is a request that includes all optional parameters - # Complete-V2024Campaign -Id $Id -V2024CampaignCompleteOptions $Result + # Complete-V2024Campaign -Id $Id -CampaignCompleteOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024Campaign" Write-Host $_.ErrorDetails @@ -310,10 +310,10 @@ $Campaign = @"{ try { $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-V2024Campaign -V2024Campaign $Result + New-V2024Campaign -Campaign $Result # Below is a request that includes all optional parameters - # New-V2024Campaign -V2024Campaign $Result + # New-V2024Campaign -Campaign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Campaign" Write-Host $_.ErrorDetails @@ -480,10 +480,10 @@ $CampaignTemplate = @"{ try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-V2024CampaignTemplate -V2024CampaignTemplate $Result + New-V2024CampaignTemplate -CampaignTemplate $Result # Below is a request that includes all optional parameters - # New-V2024CampaignTemplate -V2024CampaignTemplate $Result + # New-V2024CampaignTemplate -CampaignTemplate $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignTemplate" Write-Host $_.ErrorDetails @@ -624,10 +624,10 @@ $CampaignsDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest - Remove-V2024Campaigns -V2024CampaignsDeleteRequest $Result + Remove-V2024Campaigns -CampaignsDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024Campaigns -V2024CampaignsDeleteRequest $Result + # Remove-V2024Campaigns -CampaignsDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Campaigns" Write-Host $_.ErrorDetails @@ -1027,10 +1027,10 @@ $AdminReviewReassign = @"{ try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move-V2024 -Id $Id -V2024AdminReviewReassign $Result + Move-V2024 -Id $Id -AdminReviewReassign $Result # Below is a request that includes all optional parameters - # Move-V2024 -Id $Id -V2024AdminReviewReassign $Result + # Move-V2024 -Id $Id -AdminReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2024" Write-Host $_.ErrorDetails @@ -1082,10 +1082,10 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024CampaignTemplate -Id $Id -V2024JsonPatchOperation $Result + Update-V2024CampaignTemplate -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024CampaignTemplate -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024CampaignTemplate -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignTemplate" Write-Host $_.ErrorDetails @@ -1131,10 +1131,10 @@ $CampaignReportsConfig = @"{ try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $Result + Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result # Below is a request that includes all optional parameters - # Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $Result + # Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignReportsConfig" Write-Host $_.ErrorDetails @@ -1202,7 +1202,7 @@ try { Set-V2024CampaignTemplateSchedule -Id $Id # Below is a request that includes all optional parameters - # Set-V2024CampaignTemplateSchedule -Id $Id -V2024Schedule $Result + # Set-V2024CampaignTemplateSchedule -Id $Id -Schedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignTemplateSchedule" Write-Host $_.ErrorDetails @@ -1253,7 +1253,7 @@ try { Start-V2024Campaign -Id $Id # Below is a request that includes all optional parameters - # Start-V2024Campaign -Id $Id -V2024ActivateCampaignOptions $Result + # Start-V2024Campaign -Id $Id -ActivateCampaignOptions $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Campaign" Write-Host $_.ErrorDetails @@ -1457,10 +1457,10 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Campaign -Id $Id -V2024JsonPatchOperation $Result + Update-V2024Campaign -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Campaign -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024Campaign -Id $Id -JsonPatchOperation $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/V2024CertificationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md index 94c012c659a0..68a1474467c4 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md @@ -478,10 +478,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campa try { $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision - Select-V2024IdentityDecision -Id $Id -V2024ReviewDecision $Result + Select-V2024IdentityDecision -Id $Id -ReviewDecision $Result # Below is a request that includes all optional parameters - # Select-V2024IdentityDecision -Id $Id -V2024ReviewDecision $Result + # Select-V2024IdentityDecision -Id $Id -ReviewDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2024IdentityDecision" Write-Host $_.ErrorDetails @@ -537,10 +537,10 @@ $ReviewReassign = @"{ try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Invoke-V2024ReassignIdentityCertifications -Id $Id -V2024ReviewReassign $Result + Invoke-V2024ReassignIdentityCertifications -Id $Id -ReviewReassign $Result # Below is a request that includes all optional parameters - # Invoke-V2024ReassignIdentityCertifications -Id $Id -V2024ReviewReassign $Result + # Invoke-V2024ReassignIdentityCertifications -Id $Id -ReviewReassign $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ReassignIdentityCertifications" Write-Host $_.ErrorDetails @@ -647,10 +647,10 @@ $ReviewReassign = @"{ try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-V2024ReassignCertsAsync -Id $Id -V2024ReviewReassign $Result + Submit-V2024ReassignCertsAsync -Id $Id -ReviewReassign $Result # Below is a request that includes all optional parameters - # Submit-V2024ReassignCertsAsync -Id $Id -V2024ReviewReassign $Result + # Submit-V2024ReassignCertsAsync -Id $Id -ReviewReassign $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 69ae7b6ee55e..24bc1f43bac3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md @@ -83,10 +83,10 @@ $DeployRequest = @"{ try { $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest - New-V2024Deploy -V2024DeployRequest $Result + New-V2024Deploy -DeployRequest $Result # Below is a request that includes all optional parameters - # New-V2024Deploy -V2024DeployRequest $Result + # New-V2024Deploy -DeployRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy" Write-Host $_.ErrorDetails @@ -141,10 +141,10 @@ $ObjectMappingRequest = @"{ try { $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest - New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result + New-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result # Below is a request that includes all optional parameters - # New-V2024ObjectMapping -SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result + # New-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping" Write-Host $_.ErrorDetails @@ -207,10 +207,10 @@ $ObjectMappingBulkCreateRequest = @"{ try { $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest - New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result + New-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result # Below is a request that includes all optional parameters - # New-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result + # New-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings" Write-Host $_.ErrorDetails @@ -844,10 +844,10 @@ $ObjectMappingBulkPatchRequest = @"{ try { $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest - Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result + Update-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result # Below is a request that includes all optional parameters - # Update-V2024ObjectMappings -SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result + # Update-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $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 e19cb940e65f..a302daa6b867 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md @@ -97,10 +97,10 @@ $ConnectorRuleCreateRequest = @"{ try { $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest - New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result + New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -ConnectorRuleCreateRequest $Result # Below is a request that includes all optional parameters - # New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result + # New-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -ConnectorRuleCreateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorRule" Write-Host $_.ErrorDetails @@ -335,7 +335,7 @@ try { Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleUpdateRequest $Result + # Send-V2024ConnectorRule -Id $Id -XSailPointExperimental $XSailPointExperimental -ConnectorRuleUpdateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorRule" Write-Host $_.ErrorDetails @@ -386,10 +386,10 @@ $SourceCode = @"{ try { $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode - Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result + Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -SourceCode $Result # Below is a request that includes all optional parameters - # Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result + # Test-V2024ConnectorRule -XSailPointExperimental $XSailPointExperimental -SourceCode $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 800be00b1283..e7c2f4235192 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md @@ -88,10 +88,10 @@ $V3CreateConnectorDto = @"{ try { $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto - New-V2024CustomConnector -V2024V3CreateConnectorDto $Result + New-V2024CustomConnector -V3CreateConnectorDto $Result # Below is a request that includes all optional parameters - # New-V2024CustomConnector -V2024V3CreateConnectorDto $Result + # New-V2024CustomConnector -V3CreateConnectorDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector" Write-Host $_.ErrorDetails @@ -680,10 +680,10 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Connector -ScriptName $ScriptName -V2024JsonPatchOperation $Result + Update-V2024Connector -ScriptName $ScriptName -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Connector -ScriptName $ScriptName -V2024JsonPatchOperation $Result + # Update-V2024Connector -ScriptName $ScriptName -JsonPatchOperation $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 9e82457a8e63..4d1508ce4b10 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md @@ -197,7 +197,7 @@ try { New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -V2024Body $Result + # New-V2024FormDefinition -XSailPointExperimental $XSailPointExperimental -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" Write-Host $_.ErrorDetails @@ -256,7 +256,7 @@ try { New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -V2024Body $Result + # New-V2024FormDefinitionDynamicSchema -XSailPointExperimental $XSailPointExperimental -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" Write-Host $_.ErrorDetails @@ -382,7 +382,7 @@ try { New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -V2024Body $Result + # New-V2024FormInstance -XSailPointExperimental $XSailPointExperimental -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" Write-Host $_.ErrorDetails @@ -756,7 +756,7 @@ try { Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -V2024Body $Result + # Import-V2024FormDefinitions -XSailPointExperimental $XSailPointExperimental -Body $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" Write-Host $_.ErrorDetails @@ -1148,7 +1148,7 @@ try { Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -V2024FormElementPreviewRequest $Result + # Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $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 fe68516d71bd..3368e9d0f0b3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md @@ -75,10 +75,10 @@ $CustomPasswordInstruction = @"{ try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction - New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result + New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result # Below is a request that includes all optional parameters - # New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result + # New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-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 2bb788cae4ce..2e955dc66db2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md @@ -65,10 +65,10 @@ $DataSegment = @""@ try { $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment - New-V2024DataSegment -V2024DataSegment $Result + New-V2024DataSegment -DataSegment $Result # Below is a request that includes all optional parameters - # New-V2024DataSegment -V2024DataSegment $Result + # New-V2024DataSegment -DataSegment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-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 523d51283f12..9a5ff1f47f56 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md @@ -154,10 +154,10 @@ $Dimension = @"{ try { $Result = ConvertFrom-JsonToDimension -Json $Dimension - New-V2024Dimension -RoleId $RoleId -V2024Dimension $Result + New-V2024Dimension -RoleId $RoleId -Dimension $Result # Below is a request that includes all optional parameters - # New-V2024Dimension -RoleId $RoleId -V2024Dimension $Result + # New-V2024Dimension -RoleId $RoleId -Dimension $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Dimension" Write-Host $_.ErrorDetails @@ -207,10 +207,10 @@ $DimensionBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest - Remove-V2024BulkDimensions -RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result + Remove-V2024BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024BulkDimensions -RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result + # Remove-V2024BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkDimensions" Write-Host $_.ErrorDetails @@ -541,10 +541,10 @@ $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -V2024JsonPatchOperation $Result + Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -V2024JsonPatchOperation $Result + # Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $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 c16812452439..8e669e563bb1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md @@ -595,7 +595,7 @@ try { Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + # Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" Write-Host $_.ErrorDetails @@ -658,10 +658,10 @@ $EntitlementRequestConfig = @"{ try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig - Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result + Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result # Below is a request that includes all optional parameters - # Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result + # Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" Write-Host $_.ErrorDetails @@ -777,10 +777,10 @@ $EntitlementBulkUpdateRequest = @"{ try { $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest - Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result + Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result # Below is a request that includes all optional parameters - # Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result + # Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $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 f12f771ed0b6..eb18b82a815f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md @@ -65,10 +65,10 @@ $NetworkConfiguration = @"{ try { $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration - New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $Result + New-V2024AuthOrgNetworkConfig -NetworkConfiguration $Result # Below is a request that includes all optional parameters - # New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $Result + # New-V2024AuthOrgNetworkConfig -NetworkConfiguration $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails @@ -162,10 +162,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $Result + Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $Result + # Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $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 50dab89b3754..b22ec6d078e8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md @@ -89,10 +89,10 @@ $WorkgroupDto = @"{ try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto - New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result + New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result # Below is a request that includes all optional parameters - # New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result + # New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup" Write-Host $_.ErrorDetails @@ -196,10 +196,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result # Below is a request that includes all optional parameters - # Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + # Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers" Write-Host $_.ErrorDetails @@ -260,10 +260,10 @@ $WorkgroupBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest - Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result + Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result + # Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk" Write-Host $_.ErrorDetails @@ -547,7 +547,7 @@ try { Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + # Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup" Write-Host $_.ErrorDetails @@ -602,10 +602,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity - Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result # Below is a request that includes all optional parameters - # Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + # Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $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 c9b12c4216fd..ffd15ce6f20b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md @@ -22,11 +22,9 @@ Method | HTTP request | Description [**Add-V2024AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations [**Add-V2024AccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Notification of Viewed Access Request Recommendations in Bulk [**Get-V2024AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations -[**Get-V2024AccessRequestRecommendationsConfig**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config [**Get-V2024AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations [**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 -[**Set-V2024AccessRequestRecommendationsConfig**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config ## add-access-request-recommendations-ignored-item @@ -75,10 +73,10 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + # Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem" Write-Host $_.ErrorDetails @@ -132,10 +130,10 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + # Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem" Write-Host $_.ErrorDetails @@ -189,10 +187,10 @@ $AccessRequestRecommendationActionItemDto = @"{ try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + # Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem" Write-Host $_.ErrorDetails @@ -247,10 +245,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result # Below is a request that includes all optional parameters - # Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + # Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails @@ -320,54 +318,6 @@ try { ``` [[Back to top]](#) -## get-access-request-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. -::: -This API returns the configurations for Access Request Recommender for the tenant. - -[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-config) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. - -### Return type -[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto -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 -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - -# Get Access Request Recommendations config - -try { - Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig" - 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. @@ -541,61 +491,3 @@ try { } ``` [[Back to top]](#) - -## set-access-request-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. -::: -This API updates the configurations for Access Request Recommender for the tenant. - -[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-recommendations-config) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. - Body | AccessRequestRecommendationConfigDto | [**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) | True | The desired configurations for Access Request Recommender for the tenant. - -### Return type -[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Successfully updated configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto -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 -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -$AccessRequestRecommendationConfigDto = @"{ - "scoreThreshold" : 0.5, - "startDateAttribute" : "startDate", - "restrictionAttribute" : "location", - "moverAttribute" : "isMover", - "joinerAttribute" : "isJoiner", - "useRestrictionAttribute" : true -}"@ - -# Update Access Request Recommendations config - -try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto - Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAICommonAccessApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAICommonAccessApi.md index 5a3b9fedd09f..37f0d1940484 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAICommonAccessApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAICommonAccessApi.md @@ -72,10 +72,10 @@ $CommonAccessItemRequest = @"{ try { $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest - New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result + New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result # Below is a request that includes all optional parameters - # New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result + # New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess" Write-Host $_.ErrorDetails @@ -184,10 +184,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus - Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result + Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result # Below is a request that includes all optional parameters - # Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result + # Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $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/V2024IAIRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md index 72bf34b43296..d3907577d749 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md @@ -80,10 +80,10 @@ $RecommendationRequestDto = @"{ try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto - Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result + Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result # Below is a request that includes all optional parameters - # Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result + # Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations" Write-Host $_.ErrorDetails @@ -182,10 +182,10 @@ $RecommendationConfigDto = @"{ try { $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto - Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result + Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result # Below is a request that includes all optional parameters - # Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result + # Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $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 04b5523601e7..908538faa966 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRoleMiningApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRoleMiningApi.md @@ -100,7 +100,7 @@ try { New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -V2024RoleMiningPotentialRoleProvisionRequest $Result + # New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest" Write-Host $_.ErrorDetails @@ -179,10 +179,10 @@ $RoleMiningSessionDto = @"{ try { $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto - New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result + New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result # Below is a request that includes all optional parameters - # New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result + # New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions" Write-Host $_.ErrorDetails @@ -342,7 +342,7 @@ try { Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleExportRequest $Result + # Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync" Write-Host $_.ErrorDetails @@ -1314,10 +1314,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + # Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole" Write-Host $_.ErrorDetails @@ -1383,10 +1383,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + # Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0" Write-Host $_.ErrorDetails @@ -1442,10 +1442,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + # Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession" Write-Host $_.ErrorDetails @@ -1499,10 +1499,10 @@ $RoleMiningPotentialRoleEditEntitlements = @"{ try { $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements - Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result + Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result # Below is a request that includes all optional parameters - # Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result + # Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $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/V2024IdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md index 949450bc7a74..e41f0e9e918c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md @@ -466,10 +466,10 @@ $SendAccountVerificationRequest = @"{ try { $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest - Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -V2024SendAccountVerificationRequest $Result + Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result # Below is a request that includes all optional parameters - # Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -V2024SendAccountVerificationRequest $Result + # Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken" Write-Host $_.ErrorDetails @@ -526,10 +526,10 @@ $InviteIdentitiesRequest = @"{ try { $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest - Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result + Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result # Below is a request that includes all optional parameters - # Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result + # Start-V2024IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite" Write-Host $_.ErrorDetails @@ -587,10 +587,10 @@ $ProcessIdentitiesRequest = @"{ try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest - Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result + Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result # Below is a request that includes all optional parameters - # Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result + # Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing" 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 4eca840bb1eb..f9c52a68c3fd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md @@ -87,10 +87,10 @@ $IdentityAttribute = @"{ try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result # Below is a request that includes all optional parameters - # New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + # New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute" Write-Host $_.ErrorDetails @@ -192,10 +192,10 @@ $IdentityAttributeNames = @"{ try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames - Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result + Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result # Below is a request that includes all optional parameters - # Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result + # Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -IdentityAttributeNames $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk" Write-Host $_.ErrorDetails @@ -374,10 +374,10 @@ $IdentityAttribute = @"{ try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $Result # Below is a request that includes all optional parameters - # Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + # Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -IdentityAttribute $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/V2024IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md index b4e04aa9b921..90e793ceb6bc 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md @@ -27,21 +27,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile -[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile +[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile +[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile [**Remove-V2024IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles [**Export-V2024IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles [**Get-V2024DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config -[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile +[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get single Identity Profile [**Import-V2024IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles -[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles +[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List [**Show-V2024IdentityPreview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview [**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 Identity Profile +[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile ## create-identity-profile -Creates an identity profile. +This creates an Identity Profile. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-profile) @@ -56,7 +56,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -201 | Created identity profile. | IdentityProfile +201 | The created Identity Profile | IdentityProfile 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 @@ -119,14 +119,14 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create Identity Profile +# Create an Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-V2024IdentityProfile -V2024IdentityProfile $Result + New-V2024IdentityProfile -IdentityProfile $Result # Below is a request that includes all optional parameters - # New-V2024IdentityProfile -V2024IdentityProfile $Result + # New-V2024IdentityProfile -IdentityProfile $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityProfile" Write-Host $_.ErrorDetails @@ -135,15 +135,19 @@ try { [[Back to top]](#) ## delete-identity-profile -Delete an identity profile by ID. +This deletes an Identity Profile based on ID. + 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 ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | IdentityProfileId | **String** | True | The Identity Profile ID. ### Return type [**TaskResultSimplified**](../models/task-result-simplified) @@ -165,9 +169,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. -# Delete Identity Profile +# Delete an Identity Profile try { Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -333,14 +337,14 @@ try { [[Back to top]](#) ## get-identity-profile -Get a single identity profile by ID. +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 ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | IdentityProfileId | **String** | True | The Identity Profile ID. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -348,7 +352,7 @@ Path | IdentityProfileId | **String** | True | Identity profile ID. ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Identity profile object. | IdentityProfile +200 | An Identity Profile object. | IdentityProfile 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 @@ -362,9 +366,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. -# Get Identity Profile +# Get single Identity Profile try { Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -475,10 +479,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $Result + Import-V2024IdentityProfiles -IdentityProfileExportedObject $Result # Below is a request that includes all optional parameters - # Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $Result + # Import-V2024IdentityProfiles -IdentityProfileExportedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024IdentityProfiles" Write-Host $_.ErrorDetails @@ -487,7 +491,7 @@ try { [[Back to top]](#) ## list-identity-profiles -Get a list of identity profiles, based on the specified query parameters. +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) @@ -497,7 +501,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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* + 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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* 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: **id, name, priority, created, modified, owner.id, owner.name** ### Return type @@ -506,7 +510,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of identity profiles. | IdentityProfile[] +200 | List of identityProfiles. | IdentityProfile[] 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 @@ -522,10 +526,10 @@ Code | Description | Data Type $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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) +$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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (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, priority, created, modified, owner.id, owner.name** (optional) -# List Identity Profiles +# Identity Profiles List try { Get-V2024IdentityProfiles @@ -601,10 +605,10 @@ $IdentityPreviewRequest = @"{ try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - Show-V2024IdentityPreview -V2024IdentityPreviewRequest $Result + Show-V2024IdentityPreview -IdentityPreviewRequest $Result # Below is a request that includes all optional parameters - # Show-V2024IdentityPreview -V2024IdentityPreviewRequest $Result + # Show-V2024IdentityPreview -IdentityPreviewRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024IdentityPreview" Write-Host $_.ErrorDetails @@ -663,23 +667,25 @@ try { [[Back to top]](#) ## update-identity-profile -Update a specified identity profile with this PATCH request. +This updates the specified Identity Profile. -You cannot update these fields: + +Some fields of the Schema cannot be updated. These fields are listed below: * id +* name * created * modified * identityCount * identityRefreshRequired -* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. +* 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 ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | Identity profile ID. - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Path | IdentityProfileId | **String** | True | The Identity Profile ID + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -687,7 +693,7 @@ Path | IdentityProfileId | **String** | True | Identity profile ID. ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Updated identity profile. | IdentityProfile +200 | The updated Identity Profile. | IdentityProfile 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 @@ -701,22 +707,22 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" -}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update Identity Profile +# Update the Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result + Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result + # Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $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 949de1c07ce0..559b6770b8a7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md @@ -124,10 +124,10 @@ $LifecycleState = @"{ try { $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState - New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result + New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result # Below is a request that includes all optional parameters - # New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result + # New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024LifecycleState" Write-Host $_.ErrorDetails @@ -322,10 +322,10 @@ $SetLifecycleStateRequest = @""@ try { $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest - Set-V2024LifecycleState -IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result + Set-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result # Below is a request that includes all optional parameters - # Set-V2024LifecycleState -IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result + # Set-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024LifecycleState" Write-Host $_.ErrorDetails @@ -378,10 +378,10 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result + Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result + # Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $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 680d2a34a64c..00d3bdc4c378 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md @@ -202,10 +202,10 @@ $MfaDuoConfig = @"{ try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result + Set-V2024MFADuoConfig -MfaDuoConfig $Result # Below is a request that includes all optional parameters - # Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result + # Set-V2024MFADuoConfig -MfaDuoConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" Write-Host $_.ErrorDetails @@ -252,10 +252,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result + Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result + # Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" Write-Host $_.ErrorDetails @@ -304,10 +304,10 @@ $MfaOktaConfig = @"{ try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result + Set-V2024MFAOktaConfig -MfaOktaConfig $Result # Below is a request that includes all optional parameters - # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result + # Set-V2024MFAOktaConfig -MfaOktaConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md deleted file mode 100644 index dcf869e042b3..000000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md +++ /dev/null @@ -1,190 +0,0 @@ ---- -id: v2024-machine-accounts -title: MachineAccounts -pagination_label: MachineAccounts -sidebar_label: MachineAccounts -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MachineAccounts', 'V2024MachineAccounts'] -slug: /tools/sdk/powershell/v2024/methods/machine-accounts -tags: ['SDK', 'Software Development Kit', 'MachineAccounts', 'V2024MachineAccounts'] ---- - -# MachineAccounts - - - -All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-V2024MachineAccount**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine Account Details -[**Get-V2024MachineAccounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine Accounts List -[**Update-V2024MachineAccount**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a Machine Account - - -## get-machine-account -:::warning experimental -This API is currently in an experimental state. The API is subject to 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 the details for a single machine account by its ID. - -[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-account) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Machine Account ID. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. - -### Return type -[**MachineAccount**](../models/machine-account) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Machine Account object. | MachineAccount -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - -# Machine Account Details - -try { - Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) - -## list-machine-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. -::: -This returns a list of machine accounts. - -[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-accounts) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. - 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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** - -### Return type -[**MachineAccount[]**](../models/machine-account) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of machine account objects | MachineAccount[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$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 = 'identityId eq "2c9180858082150f0180893dbaf44201"' # 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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *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, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) - -# Machine Accounts List - -try { - Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) - -## update-machine-account -:::warning experimental -This API is currently in an experimental state. The API is subject to 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 machine accounts details. - - -[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-account) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Machine Account ID. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. - Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - -### Return type -[**MachineAccount**](../models/machine-account) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Updated Machine Account object. | MachineAccount -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -$RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - -# Update a Machine Account - -try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md deleted file mode 100644 index 28983d9b26bd..000000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md +++ /dev/null @@ -1,298 +0,0 @@ ---- -id: v2024-machine-identities -title: MachineIdentities -pagination_label: MachineIdentities -sidebar_label: MachineIdentities -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentities', 'V2024MachineIdentities'] -slug: /tools/sdk/powershell/v2024/methods/machine-identities -tags: ['SDK', 'Software Development Kit', 'MachineIdentities', 'V2024MachineIdentities'] ---- - -# MachineIdentities - - - -All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-V2024MachineIdentity**](#create-machine-identity) | **POST** `/machine-identities` | Create Machine Identities -[**Remove-V2024MachineIdentity**](#delete-machine-identity) | **DELETE** `/machine-identities/{id}` | Delete machine identity -[**Get-V2024MachineIdentity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine Identity Details -[**Get-V2024MachineIdentities**](#list-machine-identities) | **GET** `/machine-identities` | List Machine Identities -[**Update-V2024MachineIdentity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a Machine Identity - - -## create-machine-identity -Use this API to create a machine identity. -The maximum supported length for the description field is 2000 characters. - -[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-machine-identity) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | MachineIdentity | [**MachineIdentity**](../models/machine-identity) | True | - -### Return type -[**MachineIdentity**](../models/machine-identity) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Machine Identity created. | MachineIdentity -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$MachineIdentity = @"{ - "created" : "2015-05-28T14:07:17Z", - "businessApplication" : "ADService", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "", - "attributes" : "{\"Region\":\"EU\"}", - "id" : "id12345", - "manuallyEdited" : true -}"@ - -# Create Machine Identities - -try { - $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity - New-V2024MachineIdentity -V2024MachineIdentity $Result - - # Below is a request that includes all optional parameters - # New-V2024MachineIdentity -V2024MachineIdentity $Result -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) - -## delete-machine-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 machine identity was deleted. - -[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-identity) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Machine Identity ID - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. - -### Return type - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - -# Delete machine identity - -try { - Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) - -## get-machine-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 machine identity using the Machine Identity ID. - -[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-identity) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Machine Identity ID - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. - -### Return type -[**MachineIdentity**](../models/machine-identity) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A machine identity object | MachineIdentity -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - -# Machine Identity Details - -try { - Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) - -## list-machine-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 machine identities. - -[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-identities) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. - 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: **businessApplication, name** - 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 | 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. - -### Return type -[**MachineIdentity[]**](../models/machine-identity) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of machine identities. | MachineIdentity[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -$Sorters = "businessApplication" # 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: **businessApplication, name** (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) -$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 Machine Identities - -try { - Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) - -## update-machine-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 API to update machine identity details. - - -[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-identity) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Machine Identity ID. - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. - Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - -### Return type -[**MachineIdentity**](../models/machine-identity) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Updated Machine Identity object. | MachineIdentity -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -$RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - - -# Update a Machine Identity - -try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md index 4f9320afc553..8757d29f1fb5 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md @@ -68,10 +68,10 @@ $ManagedClientRequest = @"{ try { $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-V2024ManagedClient -V2024ManagedClientRequest $Result + New-V2024ManagedClient -ManagedClientRequest $Result # Below is a request that includes all optional parameters - # New-V2024ManagedClient -V2024ManagedClientRequest $Result + # New-V2024ManagedClient -ManagedClientRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" Write-Host $_.ErrorDetails @@ -312,10 +312,10 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result + Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024ManagedClient -Id $Id -JsonPatchOperation $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 a821393e5fa8..73588966c977 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md @@ -72,10 +72,10 @@ $ManagedClusterRequest = @"{ try { $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-V2024ManagedCluster -V2024ManagedClusterRequest $Result + New-V2024ManagedCluster -ManagedClusterRequest $Result # Below is a request that includes all optional parameters - # New-V2024ManagedCluster -V2024ManagedClusterRequest $Result + # New-V2024ManagedCluster -ManagedClusterRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" Write-Host $_.ErrorDetails @@ -312,10 +312,10 @@ $PutClientLogConfigurationRequest = @""@ try { $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result + Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result # Below is a request that includes all optional parameters - # Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result + # Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" Write-Host $_.ErrorDetails @@ -366,10 +366,10 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result + Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $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 460c47d0e3cb..0fcbcb23aaa7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md @@ -121,10 +121,10 @@ $NonEmployeeApprovalDecision = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result + Approve-V2024NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result # Below is a request that includes all optional parameters - # Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result + # Approve-V2024NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails @@ -181,10 +181,10 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result + New-V2024NonEmployeeRecord -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result + # New-V2024NonEmployeeRecord -NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails @@ -240,10 +240,10 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result + New-V2024NonEmployeeRequest -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result + # New-V2024NonEmployeeRequest -NonEmployeeRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails @@ -252,7 +252,7 @@ try { [[Back to top]](#) ## create-non-employee-source -Create a 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) @@ -311,10 +311,10 @@ $NonEmployeeSourceRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result + New-V2024NonEmployeeSource -NonEmployeeSourceRequestBody $Result # Below is a request that includes all optional parameters - # New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result + # New-V2024NonEmployeeSource -NonEmployeeSourceRequestBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" Write-Host $_.ErrorDetails @@ -367,10 +367,10 @@ $NonEmployeeSchemaAttributeBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result + New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result # Below is a request that includes all optional parameters - # New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result + # New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSourceSchemaAttributes" Write-Host $_.ErrorDetails @@ -459,10 +459,10 @@ $DeleteNonEmployeeRecordsInBulkRequest = @""@ try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest - Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $Result + Remove-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $Result + # Remove-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecordsInBulk" Write-Host $_.ErrorDetails @@ -1404,20 +1404,22 @@ try { [[Back to top]](#) ## list-non-employee-sources -Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: - 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. - 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. +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 +she may request a list sources 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 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 ------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. 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 | RequestedFor | **String** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. - Query | NonEmployeeCount | **Boolean** | (optional) (default to $false) | Flag that determines whether the API will return a non-employee count associated with the source. + Query | NonEmployeeCount | **Boolean** | (optional) | The flag to determine whether return a non-employee count associate with source. 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: **name, created, sourceId** ### Return type @@ -1439,20 +1441,20 @@ Code | Description | Data Type ### Example ```powershell +$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $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) -$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) -$NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) +$NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) $Sorters = "name,created" # 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, created, sourceId** (optional) # List Non-Employee Sources try { - Get-V2024NonEmployeeSources + Get-V2024NonEmployeeSources -RequestedFor $RequestedFor # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $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 @@ -1507,10 +1509,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024NonEmployeeRecord -Id $Id -V2024JsonPatchOperation $Result + Update-V2024NonEmployeeRecord -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeRecord -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024NonEmployeeRecord -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails @@ -1565,10 +1567,10 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -V2024JsonPatchOperation $Result + Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -V2024JsonPatchOperation $Result + # Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSchemaAttribute" Write-Host $_.ErrorDetails @@ -1618,10 +1620,10 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024NonEmployeeSource -SourceId $SourceId -V2024JsonPatchOperation $Result + Update-V2024NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeSource -SourceId $SourceId -V2024JsonPatchOperation $Result + # Update-V2024NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSource" Write-Host $_.ErrorDetails @@ -1668,10 +1670,10 @@ $NonEmployeeRejectApprovalDecision = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeRejectApprovalDecision $Result + Deny-V2024NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result # Below is a request that includes all optional parameters - # Deny-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeRejectApprovalDecision $Result + # Deny-V2024NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails @@ -1734,10 +1736,10 @@ $NonEmployeeRequestBody = @"{ try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-V2024NonEmployeeRecord -Id $Id -V2024NonEmployeeRequestBody $Result + Update-V2024NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # Update-V2024NonEmployeeRecord -Id $Id -V2024NonEmployeeRequestBody $Result + # Update-V2024NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $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 2971ea5ffaa5..ad47ac7445d7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md @@ -77,10 +77,10 @@ $DomainAddress = @"{ try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress - New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result + New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result # Below is a request that includes all optional parameters - # New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result + # New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim" Write-Host $_.ErrorDetails @@ -147,10 +147,10 @@ $TemplateDto = @"{ try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto - New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result + New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result # Below is a request that includes all optional parameters - # New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result + # New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate" Write-Host $_.ErrorDetails @@ -203,10 +203,10 @@ $EmailStatusDto = @"{ try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto - New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result + New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result # Below is a request that includes all optional parameters - # New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result + # New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress" Write-Host $_.ErrorDetails @@ -259,10 +259,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto - Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result + Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result # Below is a request that includes all optional parameters - # Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result + # Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk" Write-Host $_.ErrorDetails @@ -775,10 +775,10 @@ $MailFromAttributesDto = @"{ try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto - Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result + Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result # Below is a request that includes all optional parameters - # Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result + # Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes" Write-Host $_.ErrorDetails @@ -831,10 +831,10 @@ $SendTestNotificationRequestDto = @"{ try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto - Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result + Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result # Below is a request that includes all optional parameters - # Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result + # Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $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 c94cc6b6d5f1..46d51efde047 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md @@ -78,10 +78,10 @@ $CreateOAuthClientRequest = @"{ try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-V2024OauthClient -V2024CreateOAuthClientRequest $Result + New-V2024OauthClient -CreateOAuthClientRequest $Result # Below is a request that includes all optional parameters - # New-V2024OauthClient -V2024CreateOAuthClientRequest $Result + # New-V2024OauthClient -CreateOAuthClientRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient" Write-Host $_.ErrorDetails @@ -269,10 +269,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024OauthClient -Id $Id -V2024JsonPatchOperation $Result + Update-V2024OauthClient -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024OauthClient -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024OauthClient -Id $Id -JsonPatchOperation $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 a1dc7cbbae63..c5d7284acc3d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md @@ -173,10 +173,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + # Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $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 0d4d44cfa19d..db521508f2ec 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md @@ -70,10 +70,10 @@ $PasswordOrgConfig = @"{ try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result + New-V2024PasswordOrgConfig -PasswordOrgConfig $Result # Below is a request that includes all optional parameters - # New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result + # New-V2024PasswordOrgConfig -PasswordOrgConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig" Write-Host $_.ErrorDetails @@ -166,10 +166,10 @@ $PasswordOrgConfig = @"{ try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result + Send-V2024PasswordOrgConfig -PasswordOrgConfig $Result # Below is a request that includes all optional parameters - # Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $Result + # Send-V2024PasswordOrgConfig -PasswordOrgConfig $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/V2024PasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md index cf69cc9fe9ef..8d3d3cc7634d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md @@ -91,10 +91,10 @@ $PasswordDigitTokenReset = @"{ try { $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset - New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result + New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result # Below is a request that includes all optional parameters - # New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result + # New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken" Write-Host $_.ErrorDetails @@ -187,10 +187,10 @@ $PasswordInfoQueryDTO = @"{ try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $Result + Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result # Below is a request that includes all optional parameters - # Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $Result + # Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PasswordInfo" Write-Host $_.ErrorDetails @@ -258,10 +258,10 @@ $PasswordChangeRequest = @"{ try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-V2024Password -V2024PasswordChangeRequest $Result + Set-V2024Password -PasswordChangeRequest $Result # Below is a request that includes all optional parameters - # Set-V2024Password -V2024PasswordChangeRequest $Result + # Set-V2024Password -PasswordChangeRequest $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 3f552003c315..7883a7c4d76c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md @@ -100,10 +100,10 @@ $PasswordPolicyV3Dto = @"{ try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $Result + New-V2024PasswordPolicy -PasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters - # New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $Result + # New-V2024PasswordPolicy -PasswordPolicyV3Dto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordPolicy" Write-Host $_.ErrorDetails @@ -323,10 +323,10 @@ $PasswordPolicyV3Dto = @"{ try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-V2024PasswordPolicy -Id $Id -V2024PasswordPolicyV3Dto $Result + Set-V2024PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result # Below is a request that includes all optional parameters - # Set-V2024PasswordPolicy -Id $Id -V2024PasswordPolicyV3Dto $Result + # Set-V2024PasswordPolicy -Id $Id -PasswordPolicyV3Dto $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 2f9c4ac0a9ed..713bc025925b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md @@ -98,10 +98,10 @@ $PasswordSyncGroup = @"{ try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result + New-V2024PasswordSyncGroup -PasswordSyncGroup $Result # Below is a request that includes all optional parameters - # New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $Result + # New-V2024PasswordSyncGroup -PasswordSyncGroup $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup" Write-Host $_.ErrorDetails @@ -294,10 +294,10 @@ $PasswordSyncGroup = @"{ try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-V2024PasswordSyncGroup -Id $Id -V2024PasswordSyncGroup $Result + Update-V2024PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result # Below is a request that includes all optional parameters - # Update-V2024PasswordSyncGroup -Id $Id -V2024PasswordSyncGroup $Result + # Update-V2024PasswordSyncGroup -Id $Id -PasswordSyncGroup $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 51bf2da37805..7ad590a0c418 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md @@ -73,10 +73,10 @@ $CreatePersonalAccessTokenRequest = @"{ try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $Result + New-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result # Below is a request that includes all optional parameters - # New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $Result + # New-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PersonalAccessToken" Write-Host $_.ErrorDetails @@ -221,10 +221,10 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024PersonalAccessToken -Id $Id -V2024JsonPatchOperation $Result + Update-V2024PersonalAccessToken -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024PersonalAccessToken -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024PersonalAccessToken -Id $Id -JsonPatchOperation $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/V2024PublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md index d70c0ba88ab4..f3f7de1730ca 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md @@ -123,10 +123,10 @@ $PublicIdentityConfig = @"{ try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $Result + Update-V2024PublicIdentityConfig -PublicIdentityConfig $Result # Below is a request that includes all optional parameters - # Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $Result + # Update-V2024PublicIdentityConfig -PublicIdentityConfig $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 f5fec5356b1e..1f5284fd0979 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md @@ -211,10 +211,10 @@ $ReportDetails = @"{ try { $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails - Start-V2024Report -V2024ReportDetails $Result + Start-V2024Report -ReportDetails $Result # Below is a request that includes all optional parameters - # Start-V2024Report -V2024ReportDetails $Result + # Start-V2024Report -ReportDetails $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/V2024RolesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md index 2cb15c688464..bcf2a4f0541b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md @@ -267,10 +267,10 @@ $Role = @"{ try { $Result = ConvertFrom-JsonToRole -Json $Role - New-V2024Role -V2024Role $Result + New-V2024Role -Role $Result # Below is a request that includes all optional parameters - # New-V2024Role -V2024Role $Result + # New-V2024Role -Role $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Role" Write-Host $_.ErrorDetails @@ -318,10 +318,10 @@ $RoleBulkDeleteRequest = @"{ try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $Result + Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result # Below is a request that includes all optional parameters - # Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $Result + # Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkRoles" Write-Host $_.ErrorDetails @@ -796,10 +796,10 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Role -Id $Id -V2024JsonPatchOperation $Result + Update-V2024Role -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Role -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024Role -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Role" Write-Host $_.ErrorDetails @@ -865,7 +865,7 @@ try { Search-V2024RolesByFilter # Below is a request that includes all optional parameters - # Search-V2024RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -V2024RoleListFilterDTO $Result + # Search-V2024RolesByFilter -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -RoleListFilterDTO $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter" Write-Host $_.ErrorDetails @@ -968,10 +968,10 @@ $RoleMetadataBulkUpdateByFilterRequest = @"{ try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest - Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $Result + Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $Result + # Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter" Write-Host $_.ErrorDetails @@ -1025,10 +1025,10 @@ $RoleMetadataBulkUpdateByIdRequest = @"{ try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest - Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $Result + Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $Result + # Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds" Write-Host $_.ErrorDetails @@ -1097,10 +1097,10 @@ $RoleMetadataBulkUpdateByQueryRequest = @"{ try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest - Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $Result + Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result # Below is a request that includes all optional parameters - # Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $Result + # Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $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 2a05166b747a..944ec4570f69 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md @@ -91,10 +91,10 @@ $SimIntegrationDetails = @"{ try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" Write-Host $_.ErrorDetails @@ -296,10 +296,10 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\" try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result # Below is a request that includes all optional parameters - # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" Write-Host $_.ErrorDetails @@ -350,10 +350,10 @@ $JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\" try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result # Below is a request that includes all optional parameters - # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" Write-Host $_.ErrorDetails @@ -421,10 +421,10 @@ $SimIntegrationDetails = @"{ try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $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 9a2b8ce7fdd7..e7112ec7570f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md @@ -153,10 +153,10 @@ $SodPolicy = @"{ try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2024SodPolicy -V2024SodPolicy $Result + New-V2024SodPolicy -SodPolicy $Result # Below is a request that includes all optional parameters - # New-V2024SodPolicy -V2024SodPolicy $Result + # New-V2024SodPolicy -SodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" Write-Host $_.ErrorDetails @@ -679,10 +679,10 @@ $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result + Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" Write-Host $_.ErrorDetails @@ -812,10 +812,10 @@ $SodPolicySchedule = @"{ try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result + Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result # Below is a request that includes all optional parameters - # Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result + # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" Write-Host $_.ErrorDetails @@ -917,10 +917,10 @@ $SodPolicy = @"{ try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result + Send-V2024SodPolicy -Id $Id -SodPolicy $Result # Below is a request that includes all optional parameters - # Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result + # Send-V2024SodPolicy -Id $Id -SodPolicy $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" Write-Host $_.ErrorDetails @@ -1012,7 +1012,7 @@ try { Start-V2024SodAllPoliciesForOrg # Below is a request that includes all optional parameters - # Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $Result + # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" 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 a94f05910234..7cb48d470363 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md @@ -86,10 +86,10 @@ $IdentityWithNewAccess = @"{ try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result + Start-V2024PredictSodViolations -IdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result + # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" Write-Host $_.ErrorDetails @@ -133,10 +133,10 @@ $IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, access try { $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result + Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result + # Start-V2024ViolationCheck -IdentityWithNewAccess1 $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 fff2b297e9a1..50057bc70348 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md @@ -27,6 +27,9 @@ Method | HTTP request | Description ## 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). @@ -35,6 +38,7 @@ For more information about the object types that currently support export functi ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | ExportPayload | [**ExportPayload**](../models/export-payload) | True | Export options control what will be included in the export. ### Return type @@ -57,6 +61,7 @@ Code | Description | Data Type ### Example ```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $ExportPayload = @"{ "description" : "Export Job 1 Test" }"@ @@ -65,10 +70,10 @@ $ExportPayload = @"{ try { $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig -V2024ExportPayload $Result + Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -ExportPayload $Result # Below is a request that includes all optional parameters - # Export-V2024SpConfig -V2024ExportPayload $Result + # Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -ExportPayload $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" Write-Host $_.ErrorDetails @@ -77,6 +82,9 @@ try { [[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 @@ -87,6 +95,7 @@ The request will need one of the following security scopes: Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of the export job whose results will be downloaded. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SpConfigExportResults**](../models/sp-config-export-results) @@ -109,14 +118,15 @@ Code | Description | Data Type ### Example ```powershell $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 -Id $Id + Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -Id $Id + # Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" Write-Host $_.ErrorDetails @@ -125,6 +135,9 @@ try { [[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 @@ -135,6 +148,7 @@ The request will need one of the following security scopes: Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of the export job whose status will be returned. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SpConfigExportJobStatus**](../models/sp-config-export-job-status) @@ -157,14 +171,15 @@ Code | Description | Data Type ### Example ```powershell $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 -Id $Id + Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -Id $Id + # Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" Write-Host $_.ErrorDetails @@ -173,6 +188,9 @@ try { [[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 @@ -183,6 +201,7 @@ The request will need the following security scope: Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of the import job whose results will be downloaded. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SpConfigImportResults**](../models/sp-config-import-results) @@ -205,14 +224,15 @@ Code | Description | Data Type ### Example ```powershell $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 -Id $Id + Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -Id $Id + # Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" Write-Host $_.ErrorDetails @@ -221,6 +241,9 @@ try { [[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, @@ -233,6 +256,7 @@ try { Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of the import job whose status will be returned. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SpConfigImportJobStatus**](../models/sp-config-import-job-status) @@ -255,14 +279,15 @@ Code | Description | Data Type ### Example ```powershell $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 -Id $Id + Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -Id $Id + # Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" Write-Host $_.ErrorDetails @@ -271,6 +296,9 @@ try { [[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\ @@ -290,6 +318,7 @@ try { ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. | Data | **System.IO.FileInfo** | True | JSON file containing the objects to be imported. Query | Preview | **Boolean** | (optional) (default to $false) | 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. | Options | [**ImportOptions**](../models/import-options) | (optional) | @@ -314,6 +343,7 @@ Code | Description | Data Type ### Example ```powershell +$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 = @""@ @@ -321,10 +351,10 @@ $Options = @""@ # Initiates configuration objects import job try { - Import-V2024SpConfig -Data $Data + Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data # Below is a request that includes all optional parameters - # Import-V2024SpConfig -Data $Data -Preview $Preview -V2024Options $Options + # Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data -Preview $Preview -Options $Options } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" Write-Host $_.ErrorDetails @@ -333,6 +363,9 @@ try { [[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) @@ -340,6 +373,7 @@ This gets the list of object configurations which are known to the tenant export ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SpConfigObject[]**](../models/sp-config-object) @@ -361,14 +395,15 @@ Code | Description | Data Type ### Example ```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get config object details try { - Get-V2024SpConfigObjects + Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects + # 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 5ccd6f10c219..5c21424a1084 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md @@ -71,10 +71,10 @@ $CreateSavedSearchRequest = @""@ try { $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result + New-V2024SavedSearch -CreateSavedSearchRequest $Result # Below is a request that includes all optional parameters - # New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result + # New-V2024SavedSearch -CreateSavedSearchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" Write-Host $_.ErrorDetails @@ -178,10 +178,10 @@ $SearchArguments = @"{ try { $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result + Invoke-V2024ExecuteSavedSearch -Id $Id -SearchArguments $Result # Below is a request that includes all optional parameters - # Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result + # Invoke-V2024ExecuteSavedSearch -Id $Id -SearchArguments $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" Write-Host $_.ErrorDetails @@ -372,10 +372,10 @@ $SavedSearch = @"{ try { $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result + Send-V2024SavedSearch -Id $Id -SavedSearch $Result # Below is a request that includes all optional parameters - # Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result + # Send-V2024SavedSearch -Id $Id -SavedSearch $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 905a25364717..0ac56d8f1a2a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md @@ -88,10 +88,10 @@ $CreateScheduledSearchRequest = @"{savedSearchId=9c620e13-cd33-4804-a13d-403bd7b try { $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result + New-V2024ScheduledSearch -CreateScheduledSearchRequest $Result # Below is a request that includes all optional parameters - # New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result + # New-V2024ScheduledSearch -CreateScheduledSearchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" Write-Host $_.ErrorDetails @@ -284,10 +284,10 @@ $TypedReference = @"{ try { $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result + Invoke-V2024UnsubscribeScheduledSearch -Id $Id -TypedReference $Result # Below is a request that includes all optional parameters - # Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result + # Invoke-V2024UnsubscribeScheduledSearch -Id $Id -TypedReference $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" Write-Host $_.ErrorDetails @@ -424,10 +424,10 @@ $ScheduledSearch = @"{ try { $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result + Update-V2024ScheduledSearch -Id $Id -ScheduledSearch $Result # Below is a request that includes all optional parameters - # Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result + # Update-V2024ScheduledSearch -Id $Id -ScheduledSearch $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 33c03048ee1f..e426a3a2b0cb 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md @@ -203,10 +203,10 @@ $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 -Search $Result # Below is a request that includes all optional parameters - # Search-V2024Aggregate -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count + # Search-V2024Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" Write-Host $_.ErrorDetails @@ -365,10 +365,10 @@ $Search = @"{ try { $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Count -V2024Search $Result + Search-V2024Count -Search $Result # Below is a request that includes all optional parameters - # Search-V2024Count -V2024Search $Result + # Search-V2024Count -Search $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" Write-Host $_.ErrorDetails @@ -581,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 -Search $Result # Below is a request that includes all optional parameters - # Search-V2024Post -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count + # Search-V2024Post -Search $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 a5e40acf4493..811f0bca496b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md @@ -85,10 +85,10 @@ $SearchAttributeConfig = @"{ try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result + New-V2024SearchAttributeConfig -SearchAttributeConfig $Result # Below is a request that includes all optional parameters - # New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result + # New-V2024SearchAttributeConfig -SearchAttributeConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails @@ -277,10 +277,10 @@ $Name = "promotedMailAttribute" # String | Name of the search attribute configur try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result + Update-V2024SearchAttributeConfig -Name $Name -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result + # Update-V2024SearchAttributeConfig -Name $Name -JsonPatchOperation $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 516ff41e02ca..5727c3506b8b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md @@ -100,10 +100,10 @@ $Segment = @"{ try { $Result = ConvertFrom-JsonToSegment -Json $Segment - New-V2024Segment -V2024Segment $Result + New-V2024Segment -Segment $Result # Below is a request that includes all optional parameters - # New-V2024Segment -V2024Segment $Result + # New-V2024Segment -Segment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-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 1e1056db443f..aa0efdb40141 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md @@ -122,10 +122,10 @@ $ServiceDeskIntegrationDto = @"{ try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result + New-V2024ServiceDeskIntegration -ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result + # New-V2024ServiceDeskIntegration -ServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails @@ -451,10 +451,10 @@ $PatchServiceDeskIntegrationRequest = @""@ try { $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result # Below is a request that includes all optional parameters - # Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + # Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails @@ -533,10 +533,10 @@ $ServiceDeskIntegrationDto = @"{ try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result + Send-V2024ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result + # Send-V2024ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails @@ -583,10 +583,10 @@ $QueuedCheckConfigDetails = @"{ try { $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result + Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $Result # Below is a request that includes all optional parameters - # Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result + # Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $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/V2024SourcesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md index 00019a8a0041..7a5e4838629f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md @@ -204,10 +204,10 @@ $ProvisioningPolicyDto = @"{ try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-V2024ProvisioningPolicy -SourceId $SourceId -V2024ProvisioningPolicyDto $Result + New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # New-V2024ProvisioningPolicy -SourceId $SourceId -V2024ProvisioningPolicyDto $Result + # New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails @@ -334,10 +334,10 @@ $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures try { $Result = ConvertFrom-JsonToSource -Json $Source - New-V2024Source -V2024Source $Result + New-V2024Source -Source $Result # Below is a request that includes all optional parameters - # New-V2024Source -V2024Source $Result -ProvisionAsCsv $ProvisionAsCsv + # New-V2024Source -Source $Result -ProvisionAsCsv $ProvisionAsCsv } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Source" Write-Host $_.ErrorDetails @@ -383,10 +383,10 @@ $Schedule1 = @""@ try { $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 - New-V2024SourceSchedule -SourceId $SourceId -V2024Schedule1 $Result + New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result # Below is a request that includes all optional parameters - # New-V2024SourceSchedule -SourceId $SourceId -V2024Schedule1 $Result + # New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchedule" Write-Host $_.ErrorDetails @@ -465,10 +465,10 @@ $Schema = @"{ try { $Result = ConvertFrom-JsonToSchema -Json $Schema - New-V2024SourceSchema -SourceId $SourceId -V2024Schema $Result + New-V2024SourceSchema -SourceId $SourceId -Schema $Result # Below is a request that includes all optional parameters - # New-V2024SourceSchema -SourceId $SourceId -V2024Schema $Result + # New-V2024SourceSchema -SourceId $SourceId -Schema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchema" Write-Host $_.ErrorDetails @@ -1870,10 +1870,10 @@ $ResourceObjectsRequest = @"{ try { $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest - Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $Result + Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -ResourceObjectsRequest $Result # Below is a request that includes all optional parameters - # Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $Result + # Receive-V2024ResourceObjects -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -ResourceObjectsRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-V2024ResourceObjects" Write-Host $_.ErrorDetails @@ -1990,10 +1990,10 @@ $CorrelationConfig = @"{ try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig - Send-V2024CorrelationConfig -Id $Id -V2024CorrelationConfig $Result + Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result # Below is a request that includes all optional parameters - # Send-V2024CorrelationConfig -Id $Id -V2024CorrelationConfig $Result + # Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024CorrelationConfig" Write-Host $_.ErrorDetails @@ -2051,10 +2051,10 @@ $NativeChangeDetectionConfig = @"{ try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig - Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $Result + Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result # Below is a request that includes all optional parameters - # Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $Result + # Send-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -NativeChangeDetectionConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig" Write-Host $_.ErrorDetails @@ -2143,10 +2143,10 @@ $ProvisioningPolicyDto = @"{ try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024ProvisioningPolicyDto $Result + Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024ProvisioningPolicyDto $Result + # Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails @@ -2286,10 +2286,10 @@ $Source = @"{ try { $Result = ConvertFrom-JsonToSource -Json $Source - Send-V2024Source -Id $Id -V2024Source $Result + Send-V2024Source -Id $Id -Source $Result # Below is a request that includes all optional parameters - # Send-V2024Source -Id $Id -V2024Source $Result + # Send-V2024Source -Id $Id -Source $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Source" Write-Host $_.ErrorDetails @@ -2358,10 +2358,10 @@ $AttrSyncSourceConfig = @"{ try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig - Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $Result + Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result # Below is a request that includes all optional parameters - # Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $Result + # Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceAttrSyncConfig" Write-Host $_.ErrorDetails @@ -2452,10 +2452,10 @@ $Schema = @"{ try { $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024Schema $Result + Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result # Below is a request that includes all optional parameters - # Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024Schema $Result + # Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema" Write-Host $_.ErrorDetails @@ -2657,10 +2657,10 @@ $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id try { $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner - Update-V2024PasswordPolicyHolders -SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $Result + Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result # Below is a request that includes all optional parameters - # Update-V2024PasswordPolicyHolders -SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $Result + # Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordPolicyHolders" Write-Host $_.ErrorDetails @@ -2746,10 +2746,10 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result + Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result + # Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" Write-Host $_.ErrorDetails @@ -2804,10 +2804,10 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result + Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result + # Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" Write-Host $_.ErrorDetails @@ -2873,10 +2873,10 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result + Update-V2024Source -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024Source -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" Write-Host $_.ErrorDetails @@ -2940,10 +2940,10 @@ $SourceEntitlementRequestConfig = @"{ try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result + Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result # Below is a request that includes all optional parameters - # Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result + # Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" Write-Host $_.ErrorDetails @@ -3001,10 +3001,10 @@ $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result + Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result + # Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" Write-Host $_.ErrorDetails @@ -3086,10 +3086,10 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result + Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result + # Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $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 60858973db9c..7313b66068bd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md @@ -30,6 +30,9 @@ Method | HTTP request | Description ## 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 @@ -42,6 +45,7 @@ Method | HTTP request | Description Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | BatchId | **String** | True | Batch Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SedBatchStats**](../models/sed-batch-stats) @@ -64,14 +68,15 @@ Code | Description | Data Type ### Example ```powershell $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Submit Sed Batch Stats Request try { - Get-V2024SedBatchStats -BatchId $BatchId + Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SedBatchStats -BatchId $BatchId + # Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" Write-Host $_.ErrorDetails @@ -80,6 +85,9 @@ try { [[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 @@ -88,6 +96,7 @@ API responses with Sed Batch Status ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**SedBatchStatus**](../models/sed-batch-status) @@ -109,14 +118,15 @@ Code | Description | Data Type ### Example ```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # List Sed Batch Request try { - Get-V2024SedBatches + Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SedBatches + # Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" Write-Host $_.ErrorDetails @@ -125,6 +135,9 @@ try { [[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: @@ -146,14 +159,14 @@ SED field descriptions: ### Parameters 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. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int64** | (optional) | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* 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: **displayName, sourceName, status** - Query | CountOnly | **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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. - Query | RequestedByAnyone | **Boolean** | (optional) (default to $false) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - Query | ShowPendingStatusOnly | **Boolean** | (optional) (default to $false) | Will limit records to items that are in ""suggested"" or ""approved"" status + Query | Count | **Boolean** | (optional) | 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. + Query | CountOnly | **Boolean** | (optional) | 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. + Query | RequestedByAnyone | **Boolean** | (optional) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested + Query | ShowPendingStatusOnly | **Boolean** | (optional) | Will limit records to items that are in ""suggested"" or ""approved"" status ### Return type [**Sed[]**](../models/sed) @@ -175,22 +188,22 @@ Code | Description | Data Type ### Example ```powershell -$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) +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) $Filters = 'displayName co "Read and Write"' # 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) $Sorters = "sorters=displayName" # 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: **displayName, sourceName, status** (optional) -$CountOnly = $false # 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) -$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) -$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) +$Count = $false # 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. (optional) +$CountOnly = $false # 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) +$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) +$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) # List Suggested Entitlement Descriptions try { - Get-V2024Seds + Get-V2024Seds -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $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 @@ -246,10 +259,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result + Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -SedPatch $Result # Below is a request that includes all optional parameters - # Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result + # Update-V2024Sed -Id $Id -XSailPointExperimental $XSailPointExperimental -SedPatch $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" Write-Host $_.ErrorDetails @@ -258,6 +271,9 @@ try { [[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 @@ -266,6 +282,7 @@ Request body takes list of SED Ids. API responses with list of SED Approval Stat ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | SedApproval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval ### Return type @@ -288,6 +305,7 @@ Code | Description | Data Type ### Example ```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedApproval = @"{ "items" : "016629d1-1d25-463f-97f3-c6686846650" }"@ # SedApproval[] | Sed Approval @@ -297,10 +315,10 @@ Code | Description | Data Type try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-V2024SedApproval -V2024SedApproval $Result + Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -SedApproval $Result # Below is a request that includes all optional parameters - # Submit-V2024SedApproval -V2024SedApproval $Result + # Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -SedApproval $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" Write-Host $_.ErrorDetails @@ -309,6 +327,9 @@ try { [[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 @@ -317,6 +338,7 @@ Request body has an assignee, and list of SED Ids that are assigned to that assi ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | SedAssignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request ### Return type @@ -339,6 +361,7 @@ Code | Description | Data Type ### Example ```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedAssignment = @"{ "assignee" : { "type" : "SOURCE_OWNER", @@ -351,10 +374,10 @@ $SedAssignment = @"{ try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-V2024SedAssignment -V2024SedAssignment $Result + Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -SedAssignment $Result # Below is a request that includes all optional parameters - # Submit-V2024SedAssignment -V2024SedAssignment $Result + # Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -SedAssignment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" Write-Host $_.ErrorDetails @@ -363,6 +386,9 @@ try { [[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 @@ -371,6 +397,7 @@ Request body has one of the following: - a list of entitlement Ids - a list of S ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. Body | SedBatchRequest | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request ### Return type @@ -393,6 +420,7 @@ Code | Description | Data Type ### Example ```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedBatchRequest = @"{ "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] @@ -401,10 +429,10 @@ $SedBatchRequest = @"{ # Submit Sed Batch Request try { - Submit-V2024SedBatchRequest + Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Submit-V2024SedBatchRequest -V2024SedBatchRequest $Result + # Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental -SedBatchRequest $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 5902ee193dac..57f46d018cdd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md @@ -173,10 +173,10 @@ $BulkRemoveTaggedObject = @"{ try { $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject - Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result + Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result # Below is a request that includes all optional parameters - # Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result + # Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject" Write-Host $_.ErrorDetails @@ -385,10 +385,10 @@ $TaggedObject = @"{ try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-V2024TaggedObject -Type $Type -Id $Id -V2024TaggedObject $Result + Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result # Below is a request that includes all optional parameters - # Send-V2024TaggedObject -Type $Type -Id $Id -V2024TaggedObject $Result + # Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject" Write-Host $_.ErrorDetails @@ -440,10 +440,10 @@ $TaggedObject = @"{ try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-V2024TagToObject -V2024TaggedObject $Result + Set-V2024TagToObject -TaggedObject $Result # Below is a request that includes all optional parameters - # Set-V2024TagToObject -V2024TaggedObject $Result + # Set-V2024TagToObject -TaggedObject $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject" Write-Host $_.ErrorDetails @@ -498,10 +498,10 @@ $BulkAddTaggedObject = @"{ try { $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject - Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result + Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result # Below is a request that includes all optional parameters - # Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result + # Set-V2024TagsToManyObjects -BulkAddTaggedObject $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 d7ec678a6dcc..84041da0b030 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md @@ -293,10 +293,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + # Update-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $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 c54ae3159103..1a7dbdbbc57a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md @@ -21,6 +21,9 @@ Method | HTTP request | Description ## 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) @@ -28,6 +31,7 @@ This rest endpoint can be used to retrieve tenant details. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. ### Return type [**Tenant**](../models/tenant) @@ -49,14 +53,15 @@ Code | Description | Data Type ### Example ```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get Tenant Information. try { - Get-V2024Tenant + Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Tenant + # 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 4b2462b49906..d4d9e872f289 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md @@ -86,10 +86,10 @@ $Transform = @"{ try { $Result = ConvertFrom-JsonToTransform -Json $Transform - New-V2024Transform -V2024Transform $Result + New-V2024Transform -Transform $Result # Below is a request that includes all optional parameters - # New-V2024Transform -V2024Transform $Result + # New-V2024Transform -Transform $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform" Write-Host $_.ErrorDetails @@ -303,7 +303,7 @@ try { Update-V2024Transform -Id $Id # Below is a request that includes all optional parameters - # Update-V2024Transform -Id $Id -V2024Transform $Result + # Update-V2024Transform -Id $Id -Transform $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 b10ab9dae854..8c24d7e9fd26 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md @@ -118,10 +118,10 @@ $CompleteInvocation = @"{ try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation - Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result + Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result # Below is a request that includes all optional parameters - # Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result + # Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation" Write-Host $_.ErrorDetails @@ -195,10 +195,10 @@ $SubscriptionPostRequest = @"{ try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest - New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result + New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result # Below is a request that includes all optional parameters - # New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result + # New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription" Write-Host $_.ErrorDetails @@ -479,10 +479,10 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner - Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result + Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result # Below is a request that includes all optional parameters - # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result + # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" Write-Host $_.ErrorDetails @@ -540,10 +540,10 @@ $TestInvocation = @"{ try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation - Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result + Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result # Below is a request that includes all optional parameters - # Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result + # Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation" Write-Host $_.ErrorDetails @@ -597,10 +597,10 @@ $ValidateFilterInputDto = @"{ try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto - Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result + Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result # Below is a request that includes all optional parameters - # Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result + # Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter" Write-Host $_.ErrorDetails @@ -683,10 +683,10 @@ $SubscriptionPutRequest = @"{ try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest - Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result + Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result # Below is a request that includes all optional parameters - # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result + # Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $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 70a3560365c3..10f8078a0b75 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md @@ -116,10 +116,10 @@ $TenantUiMetadataItemUpdateRequest = @"{ try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest - Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result + Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result # Below is a request that includes all optional parameters - # Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result + # Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $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 b5d658a6fb04..9f0aafefd87c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md @@ -85,10 +85,10 @@ $VendorConnectorMapping = @"{ try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result + New-V2024VendorConnectorMapping -VendorConnectorMapping $Result # Below is a request that includes all optional parameters - # New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result + # New-V2024VendorConnectorMapping -VendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping" Write-Host $_.ErrorDetails @@ -155,10 +155,10 @@ $VendorConnectorMapping = @"{ try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result + Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result # Below is a request that includes all optional parameters - # Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $Result + # Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md index f8a0a3836a23..283deda34d81 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md @@ -603,10 +603,10 @@ $WorkItemForward = @"{ try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result + Send-V2024WorkItemForward -Id $Id -WorkItemForward $Result # Below is a request that includes all optional parameters - # Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result + # Send-V2024WorkItemForward -Id $Id -WorkItemForward $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward" 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 454f88c2bb03..27e9da9eacc1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md @@ -84,10 +84,10 @@ $ConfigurationItemRequest = @"{ try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + # New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails @@ -448,10 +448,10 @@ $ConfigurationItemRequest = @"{ try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + # Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" Write-Host $_.ErrorDetails @@ -503,10 +503,10 @@ $TenantConfigurationRequest = @"{ try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result + Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result # Below is a request that includes all optional parameters - # Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result + # Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $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 c27c90e91c74..51896ae0cba9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md @@ -123,7 +123,7 @@ try { New-V2024ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # New-V2024ExternalExecuteWorkflow -Id $Id -V2024CreateExternalExecuteWorkflowRequest $Result + # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" Write-Host $_.ErrorDetails @@ -166,10 +166,10 @@ $CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568 try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2024Workflow -V2024CreateWorkflowRequest $Result + New-V2024Workflow -CreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # New-V2024Workflow -V2024CreateWorkflowRequest $Result + # New-V2024Workflow -CreateWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" Write-Host $_.ErrorDetails @@ -741,10 +741,10 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result + Update-V2024Workflow -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result + # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" Write-Host $_.ErrorDetails @@ -827,10 +827,10 @@ $WorkflowBody = @"{ try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result + Send-V2024Workflow -Id $Id -WorkflowBody $Result # Below is a request that includes all optional parameters - # Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result + # Send-V2024Workflow -Id $Id -WorkflowBody $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" Write-Host $_.ErrorDetails @@ -877,7 +877,7 @@ try { Test-V2024ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Test-V2024ExternalExecuteWorkflow -Id $Id -V2024TestExternalExecuteWorkflowRequest $Result + # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" Write-Host $_.ErrorDetails @@ -924,10 +924,10 @@ $TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b, try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result + Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result + # Test-V2024Workflow -Id $Id -TestWorkflowRequest $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/Models/AccessCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessCriteria.md index 303df36556c0..0ce217796011 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessCriteria.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessCriteria.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $AccessCriteria = Initialize-PSSailpoint.V2024AccessCriteria -Name money-in ` - -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] + -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileEntitlement.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileEntitlement.md index a074054331ab..08df77059128 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileEntitlement.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileEntitlement.md @@ -39,7 +39,7 @@ $AccessProfileEntitlement = Initialize-PSSailpoint.V2024AccessProfileEntitlement -Type ENTITLEMENT ` -Privileged false ` -Attribute memberOf ` - -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` -Standalone false ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileUpdateItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileUpdateItem.md index 3f821c7be336..4b81bfecb747 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileUpdateItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileUpdateItem.md @@ -29,9 +29,9 @@ $AccessProfileUpdateItem = Initialize-PSSailpoint.V2024AccessProfileUpdateItem -Requestable false ` -Status 201 ` -Description -> Access profile is updated successfully. +> Access profile is updated successfully. -> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found. +> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found. ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md index 28910c43cdd0..2c5d4965466b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $AccessRequest = Initialize-PSSailpoint.V2024AccessRequest -RequestedFor null ` -RequestType null ` -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestAdminItemStatus.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestAdminItemStatus.md index 179222409443..29b6ddb670bc 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestAdminItemStatus.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestAdminItemStatus.md @@ -68,7 +68,7 @@ $AccessRequestAdminItemStatus = Initialize-PSSailpoint.V2024AccessRequestAdminIt -Cancelable true ` -ReauthorizationRequired true ` -AccessRequestId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` - -ClientMetadata {key1=value1, key2=value2} + -ClientMetadata {key1=value1, key2=value2} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md index ef456eee84f7..e92c3778309e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $AccessRequestItem = Initialize-PSSailpoint.V2024AccessRequestItem -Type ACCESS_PROFILE ` -Id 2c9180835d2e5168015d32f890ca1581 ` -Comment Requesting access profile for John Doe ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -RemoveDate 2020-07-11T21:23:15Z ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItemResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItemResponse.md index 980f0f94e041..c132c74396a1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItemResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItemResponse.md @@ -36,7 +36,7 @@ $AccessRequestItemResponse = Initialize-PSSailpoint.V2024AccessRequestItemRespon -Description The role descrition ` -SourceId 8a80828f643d484f01643e14202e206f ` -SourceName Source1 ` - -ApprovalInfos [{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}] + -ApprovalInfos [{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md index 43950a49adab..3d26f127228b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md @@ -35,7 +35,7 @@ $AccessRequestPostApprovalRequestedItemsStatusInner = Initialize-PSSailpoint.V20 -Type ACCESS_PROFILE ` -Operation Add ` -Comment William needs this access to do his job. ` - -ClientMetadata {applicationName=My application} ` + -ClientMetadata {applicationName=My application} ` -ApprovalInfo null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md deleted file mode 100644 index 859a39adeecf..000000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationConfigDto.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: v2024-access-request-recommendation-config-dto -title: AccessRequestRecommendationConfigDto -pagination_label: AccessRequestRecommendationConfigDto -sidebar_label: AccessRequestRecommendationConfigDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto'] -slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-config-dto -tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto'] ---- - - -# AccessRequestRecommendationConfigDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ScoreThreshold** | **Double** | The value that internal calculations need to exceed for recommendations to be made. | [required] -**StartDateAttribute** | **String** | Use to map an attribute name for determining identities' start date. | [optional] -**RestrictionAttribute** | **String** | Use to only give recommendations based on this attribute. | [optional] -**MoverAttribute** | **String** | Use to map an attribute name for determining whether identities are movers. | [optional] -**JoinerAttribute** | **String** | Use to map an attribute name for determining whether identities are joiners. | [optional] -**UseRestrictionAttribute** | **Boolean** | Use only the attribute named in restrictionAttribute to make recommendations. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestRecommendationConfigDto = Initialize-PSSailpoint.V2024AccessRequestRecommendationConfigDto -ScoreThreshold 0.5 ` - -StartDateAttribute startDate ` - -RestrictionAttribute location ` - -MoverAttribute isMover ` - -JoinerAttribute isJoiner ` - -UseRestrictionAttribute true -``` - -- Convert the resource to JSON -```powershell -$AccessRequestRecommendationConfigDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationItemDetail.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationItemDetail.md index 36d819df2570..d90c723e5f63 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationItemDetail.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestRecommendationItemDetail.md @@ -34,7 +34,7 @@ $AccessRequestRecommendationItemDetail = Initialize-PSSailpoint.V2024AccessReque -Requested true ` -Viewed true ` -Messages null ` - -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] + -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse.md index f442817e2394..aa77a5c984b3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccessRequestResponse = Initialize-PSSailpoint.V2024AccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] ` - -ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] +$AccessRequestResponse = Initialize-PSSailpoint.V2024AccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] ` + -ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse1.md index 25af0bbb6cf1..512dc84ef4c3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse1.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $AccessRequestResponse1 = Initialize-PSSailpoint.V2024AccessRequestResponse1 -RequesterId 2c91808a77ff216301782327a50f09bf ` -RequesterName Bing C ` - -Items [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}] + -Items [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestTracking.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestTracking.md index e78d5e677a93..ad7b33a26382 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestTracking.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestTracking.md @@ -27,8 +27,8 @@ Name | Type | Description | Notes ```powershell $AccessRequestTracking = Initialize-PSSailpoint.V2024AccessRequestTracking -RequestedFor 2c918084660f45d6016617daa9210584 ` -RequestedItemsDetails { -"type": "ENTITLEMENT", -"id": "779c6fd7171540bba1184e5946112c28" +"type": "ENTITLEMENT", +"id": "779c6fd7171540bba1184e5946112c28" } ` -AttributesHash -1928438224 ` -AccessRequestIds [5d3118c518a44ec7805450d53479ccdb] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Account.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Account.md index fb5426b7cad9..0be9bc05b2b7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Account.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Account.md @@ -61,7 +61,7 @@ $Account = Initialize-PSSailpoint.V2024Account -Id id12345 ` -ConnectionType direct ` -IsMachine true ` -Recommendation null ` - -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` + -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` -Authoritative false ` -Description null ` -Disabled false ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivity.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivity.md index 3e49c09f29d9..b1a0a9f958c3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivity.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivity.md @@ -48,7 +48,7 @@ $AccountActivity = Initialize-PSSailpoint.V2024AccountActivity -Id 2c9180835d2e -Warnings [Some warning, another warning] ` -Items null ` -ExecutionStatus null ` - -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} + -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivityItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivityItem.md index 6aff6acb08d1..9e5dd624b59c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivityItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivityItem.md @@ -51,7 +51,7 @@ $AccountActivityItem = Initialize-PSSailpoint.V2024AccountActivityItem -Id 48c5 -NativeIdentity Sandie.Camero ` -SourceId 2c91808363ef85290164000587130c0c ` -AccountRequestInfo null ` - -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ` + -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ` -RemoveDate 2020-07-11T00:00Z ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttribute.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttribute.md index 830bc9c90a9d..2a4338930ed8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttribute.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttribute.md @@ -35,10 +35,10 @@ $AccountAttribute = Initialize-PSSailpoint.V2024AccountAttribute -SourceName Wo -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttributes.md index 6c71468762e1..1d1ea8683c4c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttributes.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttributes.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountAttributes = Initialize-PSSailpoint.V2024AccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +$AccountAttributes = Initialize-PSSailpoint.V2024AccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttributesChangedAccount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttributesChangedAccount.md index 218b5b716e95..bfd6b3356bba 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttributesChangedAccount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountAttributesChangedAccount.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $AccountAttributesChangedAccount = Initialize-PSSailpoint.V2024AccountAttributesChangedAccount -Id 52170a74-ca89-11ea-87d0-0242ac130003 ` -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 ` -Name john.doe ` - -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` -Type ACCOUNT ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountCorrelated.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountCorrelated.md index 5b7608e75f93..a73b3959950b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountCorrelated.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountCorrelated.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $AccountCorrelated = Initialize-PSSailpoint.V2024AccountCorrelated -Identity null ` -Source null ` -Account null ` - -Attributes {sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]} ` + -Attributes {sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]} ` -EntitlementCount 0 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountCorrelatedAccount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountCorrelatedAccount.md index 5df098f2e39f..f77c32d6c930 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountCorrelatedAccount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountCorrelatedAccount.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $AccountCorrelatedAccount = Initialize-PSSailpoint.V2024AccountCorrelatedAccount -Type ACCOUNT ` -Id 98da47c31df444558c211f9b205184f6 ` -Name Brian Mendoza ` - -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoDto.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoDto.md index 4f1115bfcc43..afdf12a1a9ad 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoDto.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoDto.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountInfoDto = Initialize-PSSailpoint.V2024AccountInfoDto -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` +$AccountInfoDto = Initialize-PSSailpoint.V2024AccountInfoDto -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -DisplayName Abby.Smith ` -Uuid {ad9fc391-246d-40af-b248-b6556a2b7c01} ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUncorrelatedAccount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUncorrelatedAccount.md index 8b519c66c291..b21189882b53 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUncorrelatedAccount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUncorrelatedAccount.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $AccountUncorrelatedAccount = Initialize-PSSailpoint.V2024AccountUncorrelatedAccount -Type ACCOUNT ` -Id 4dd497e3723e439991cb6d0e478375dd ` -Name Sadie Jensen ` - -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md index b901e027d0bc..9cb9ee94fc6c 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 5a9ef008184b..8cad6f292889 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AggregationResult.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AggregationResult.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AggregationResult = Initialize-PSSailpoint.V2024AggregationResult -Aggregations {Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}} ` +$AggregationResult = Initialize-PSSailpoint.V2024AggregationResult -Aggregations {Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}} ` -Hits null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AppAccountDetailsSourceAccount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AppAccountDetailsSourceAccount.md index 609aab6db071..2650b83aebc0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AppAccountDetailsSourceAccount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AppAccountDetailsSourceAccount.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $AppAccountDetailsSourceAccount = Initialize-PSSailpoint.V2024AppAccountDetailsSourceAccount -Id fbf4f72280304f1a8bc808fc2a3bcf7b ` - -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -DisplayName Abby Smith ` -SourceId 10efa58ea3954883b52bf74f489ce8f9 ` -SourceDisplayName ODS-AD-SOURCE diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AppAllOfAccount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AppAllOfAccount.md index 38cfb7b526b5..1e5c4823af27 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AppAllOfAccount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AppAllOfAccount.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $AppAllOfAccount = Initialize-PSSailpoint.V2024AppAllOfAccount -Id 2c9180837dfe6949017e21f3d8cd6d49 ` - -AccountId CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + -AccountId CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Approval.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Approval.md index e869fdf0e057..c05050632271 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Approval.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Approval.md @@ -43,17 +43,17 @@ $Approval = Initialize-PSSailpoint.V2024Approval -ApprovalId 38453251-6be2-5f8f -CreatedDate 2023-04-12T23:20:50.52Z ` -Type ENTITLEMENT_DESCRIPTIONS ` -Name null ` - -BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} ` + -BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} ` -Description null ` -Priority HIGH ` - -Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} ` + -Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} ` -Comments null ` -ApprovedBy null ` -RejectedBy null ` -CompletedDate 2023-04-12T23:20:50.52Z ` -ApprovalCriteria SINGLE ` -Status PENDING ` - -AdditionalAttributes { "llm_description": "generated description" } ` + -AdditionalAttributes { "llm_description": "generated description" } ` -ReferenceData null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AttrSyncSourceConfig.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AttrSyncSourceConfig.md index 8c6d6cd92a79..66eb5be78901 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AttrSyncSourceConfig.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AttrSyncSourceConfig.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $AttrSyncSourceConfig = Initialize-PSSailpoint.V2024AttrSyncSourceConfig -Source null ` - -Attributes [{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}] + -Attributes [{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDTOList.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDTOList.md index 0d4cb8cd49d0..d41458c49841 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDTOList.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDTOList.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AttributeDTOList = Initialize-PSSailpoint.V2024AttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] +$AttributeDTOList = Initialize-PSSailpoint.V2024AttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/BackupOptions.md b/docs/tools/sdk/powershell/Reference/V2024/Models/BackupOptions.md index 696acddbe982..3096c532795e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/BackupOptions.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/BackupOptions.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $BackupOptions = Initialize-PSSailpoint.V2024BackupOptions -IncludeTypes null ` - -ObjectOptions {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}} + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Base64Decode.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Base64Decode.md index 400420aaef09..8b6cc2f0820f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Base64Decode.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Base64Decode.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Base64Decode = Initialize-PSSailpoint.V2024Base64Decode -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Base64Encode.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Base64Encode.md index d0a4735c9fd8..f507118d048e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Base64Encode.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Base64Encode.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Base64Encode = Initialize-PSSailpoint.V2024Base64Encode -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/BaseAccount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/BaseAccount.md index 311bc7b1b7d2..72a1235d4cb9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/BaseAccount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/BaseAccount.md @@ -43,10 +43,10 @@ $BaseAccount = Initialize-PSSailpoint.V2024BaseAccount -Id 2c91808568c529c60168 -Privileged false ` -ManuallyCorrelated false ` -PasswordLastSet 2018-06-25T20:22:28.104Z ` - -EntitlementAttributes {moderator=true, admin=true, trust_level=4} ` + -EntitlementAttributes {moderator=true, admin=true, trust_level=4} ` -Created 2018-06-25T20:22:28.104Z ` -SupportsPasswordChange false ` - -AccountAttributes {type=global, admin=true, trust_level=4} + -AccountAttributes {type=global, admin=true, trust_level=4} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/BaseEntitlement.md b/docs/tools/sdk/powershell/Reference/V2024/Models/BaseEntitlement.md index 047b69b2a8ab..84c73dfd4e46 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/BaseEntitlement.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/BaseEntitlement.md @@ -32,11 +32,11 @@ Name | Type | Description | Notes $BaseEntitlement = Initialize-PSSailpoint.V2024BaseEntitlement -HasPermissions false ` -Description Cloud engineering ` -Attribute memberOf ` - -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` -Schema group ` -Privileged false ` -Id 2c918084575812550157589064f33b89 ` - -Name CN=Cloud Engineering,DC=sailpoint,DC=COM + -Name CN=Cloud Engineering,DC=sailpoint,DC=COM ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/BulkIdentitiesAccountsResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/BulkIdentitiesAccountsResponse.md index de95e520ff5d..ccdc76251dff 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/BulkIdentitiesAccountsResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/BulkIdentitiesAccountsResponse.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $BulkIdentitiesAccountsResponse = Initialize-PSSailpoint.V2024BulkIdentitiesAccountsResponse -Id 2c9180858082150f0180893dbaf553fe ` -StatusCode 404 ` - -Message Referenced identity "2c9180858082150f0180893dbaf553fe" was not found. + -Message Referenced identity "2c9180858082150f0180893dbaf553fe" was not found. ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CampaignFilterDetails.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CampaignFilterDetails.md index 29238bdf90b5..4ce86738c28f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CampaignFilterDetails.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CampaignFilterDetails.md @@ -30,10 +30,10 @@ Name | Type | Description | Notes ```powershell $CampaignFilterDetails = Initialize-PSSailpoint.V2024CampaignFilterDetails -Id 5ec18cef39020d6fd7a60ad3970aba61 ` -Name Identity Attribute Campaign Filter ` - -Description Campaign filter to certify data based on an identity attribute's specified property. ` + -Description Campaign filter to certify data based on an identity attribute's specified property. ` -Owner SailPoint Support ` -Mode INCLUSION ` - -CriteriaList [{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}] ` + -CriteriaList [{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}] ` -IsSystemFilter false ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CertificationTask.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CertificationTask.md index 5c4d78b5d11b..e2c4c9683ae8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CertificationTask.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CertificationTask.md @@ -35,7 +35,7 @@ $CertificationTask = Initialize-PSSailpoint.V2024CertificationTask -Id 2c918086 -TargetId 2c918086719eec070171a7e3355a834c ` -Status QUEUED ` -Errors null ` - -ReassignmentTrailDTOs {previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT} ` + -ReassignmentTrailDTOs {previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT} ` -Created 2020-09-24T18:10:47.693Z ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CompleteInvocation.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CompleteInvocation.md index 78ec22aade5c..cfa91138341d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CompleteInvocation.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CompleteInvocation.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $CompleteInvocation = Initialize-PSSailpoint.V2024CompleteInvocation -Secret 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` -VarError Access request is denied. ` - -Output {approved=false} + -Output {approved=false} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CompleteInvocationInput.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CompleteInvocationInput.md index f0f8997878c8..dc67730e2bd6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CompleteInvocationInput.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CompleteInvocationInput.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $CompleteInvocationInput = Initialize-PSSailpoint.V2024CompleteInvocationInput -LocalizedError null ` - -Output {approved=false} + -Output {approved=false} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CompletedApproval.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CompletedApproval.md index aa71c55761d7..2df4c24bc202 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CompletedApproval.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CompletedApproval.md @@ -66,7 +66,7 @@ $CompletedApproval = Initialize-PSSailpoint.V2024CompletedApproval -Id id12345 -CurrentRemoveDate 2020-07-11T00:00Z ` -SodViolationContext null ` -PreApprovalTriggerResult null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Concatenation.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Concatenation.md index 345629f27533..555d8a5ea583 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Concatenation.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Concatenation.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $Concatenation = Initialize-PSSailpoint.V2024Concatenation -Values [John, , Smith] ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Conditional.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Conditional.md index 40fda8d2bb9e..2c8bb2f4393e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Conditional.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Conditional.md @@ -30,7 +30,7 @@ $Conditional = Initialize-PSSailpoint.V2024Conditional -Expression ValueA eq Va -PositiveCondition true ` -NegativeCondition false ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ConnectorDetail.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ConnectorDetail.md index 282d3717481c..7d77286e5a09 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ConnectorDetail.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ConnectorDetail.md @@ -41,68 +41,68 @@ $ConnectorDetail = Initialize-PSSailpoint.V2024ConnectorDetail -Name name ` -Type ServiceNow ` -ClassName class name ` -ScriptName servicenow ` - -ApplicationXml <?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE Application PUBLIC "sailpoint.dtd" "sailpoint.dtd"> -<Application connector="sailpoint.connector.OpenConnectorAdapter" name="custom Atlassian Suite - Cloud" type="custom Atlassian Suite - Cloud"/> + -ApplicationXml + + ` - -CorrelationConfigXml <?xml version='1.0' encoding='UTF-8'?> -<!-- Copyright (C) 2021 SailPoint Technologies, Inc. All rights reserved. --> + -CorrelationConfigXml + -<!DOCTYPE CorrelationConfig PUBLIC "sailpoint.dtd" "sailpoint.dtd"> + -<CorrelationConfig name="custom Atlassian Suite - Cloud Account Correlation Config"> - <AttributeAssignments> - <Filter operation="EQ" property="email" value="mail"/> - <Filter operation="EQ" property="empId" value="employeeNumber"/> - <Filter operation="EQ" property="displayName" value="cn"/> - </AttributeAssignments> -</CorrelationConfig> + + + + + + + ` - -SourceConfigXml <?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig"> - <BaseConfig> - <Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/> - </BaseConfig> + -SourceConfigXml
+ + + -</Form> ` - -SourceConfig <?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig"> - <BaseConfig> - <Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/> - </BaseConfig> +
` + -SourceConfig
+ + + -</Form> ` +
` -SourceConfigFrom sp-connect ` -S3Location custom-connector/scriptname ` -UploadedFiles [pod/org/connectorFiles/testconnector/test1.jar] ` -FileUpload true ` -DirectConnect true ` - -TranslationProperties {de=# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved. -# DO NOT EDIT. This file is generated by "sailpointTranslate" command. -menuLabel_ConnectionSettings=Verbindungseinstellungen -menuLabel_AggregationSettings=Aggregationseinstellungen -sectionLabel_AuthenticationSettings=Verbindungseinstellungen -sectionLabel_AggregationSettings=Aggregationseinstellungen -sectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.<br><br>Geben Sie bei <strong>Zeit\u00fcberschreitung bei Verbindung</strong> die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.<br><br>Geben Sie die <strong>Host-URL</strong> der Delinea-SCIM-Serverquelle ein.<br><br>Geben Sie den <strong>API-Token</strong> der Quelle zur Authentifizierung ein. -sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.<br><br>Geben Sie in das Feld <strong>Seitengr\u00f6\u00dfe</strong> die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.<br>\n<br>Geben Sie im <strong>Kontofilter</strong> die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"<br><br>Geben Sie im <strong>Gruppenfilter</strong> die Gruppenfilterbedingungen an. Beispiel: displayName sw "S". -placeHolder_accAggregation=userName sw "S" -placeHolder_grpAggregation=displayName sw "S" -placeHolder_host=https://{Delinea_SCIM_Server_host}/v2 -docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen -docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter -HostURL=Host-URL -ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung -API_TOKEN=API-Token -JSONPathMapping=JSON-Path-Attribut-Mapping -FilterConditionForAccounts=Kontofilter -FilterConditionForGroups=Gruppenfilter -Page_Size=Seitengr\u00f6\u00dfe -SchemaAttribute=Schema-Attribut -JSONpath=JSON-Pfad -ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management.} ` - -ConnectorMetadata {supportedUI=EXTJS, platform=ccg, shortDesc=connector description} ` + -TranslationProperties {de=# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved. +# DO NOT EDIT. This file is generated by "sailpointTranslate" command. +menuLabel_ConnectionSettings=Verbindungseinstellungen +menuLabel_AggregationSettings=Aggregationseinstellungen +sectionLabel_AuthenticationSettings=Verbindungseinstellungen +sectionLabel_AggregationSettings=Aggregationseinstellungen +sectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.

Geben Sie bei Zeit\u00fcberschreitung bei Verbindung die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.

Geben Sie die Host-URL der Delinea-SCIM-Serverquelle ein.

Geben Sie den API-Token der Quelle zur Authentifizierung ein. +sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.

Geben Sie in das Feld Seitengr\u00f6\u00dfe die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.
\n
Geben Sie im Kontofilter die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"

Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw "S". +placeHolder_accAggregation=userName sw "S" +placeHolder_grpAggregation=displayName sw "S" +placeHolder_host=https://{Delinea_SCIM_Server_host}/v2 +docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen +docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter +HostURL=Host-URL +ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung +API_TOKEN=API-Token +JSONPathMapping=JSON-Path-Attribut-Mapping +FilterConditionForAccounts=Kontofilter +FilterConditionForGroups=Gruppenfilter +Page_Size=Seitengr\u00f6\u00dfe +SchemaAttribute=Schema-Attribut +JSONpath=JSON-Pfad +ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management.} ` + -ConnectorMetadata {supportedUI=EXTJS, platform=ccg, shortDesc=connector description} ` -Status RELEASED ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ConnectorDetail1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ConnectorDetail1.md index 8aeb803071e0..1d9adc79f019 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ConnectorDetail1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ConnectorDetail1.md @@ -29,13 +29,13 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ConnectorDetail1 = Initialize-PSSailpoint.V2024ConnectorDetail1 -Name JDBC ` - -SourceConfigXml <Form connectorName='Active Directory - Direct' directConnect='true' name='Active Directory' status='released' type='SourceConfig' xmlns='http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd'> - <Field defaultValue='true' hidden='true' name='cloudAuthEnabled' type='boolean' value='true'> </Field> </Form> ` - -SourceConfig {Form={Field={_defaultValue=true, _hidden=true, _name=cloudAuthEnabled, _type=boolean, _value=true}, _xmlns=http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd, _connectorName=Active Directory - Direct, _directConnect=true, _name=Active Directory, _status=released, _type=SourceConfig, __text=\n\t}} ` + -SourceConfigXml
+
` + -SourceConfig {Form={Field={_defaultValue=true, _hidden=true, _name=cloudAuthEnabled, _type=boolean, _value=true}, _xmlns=http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd, _connectorName=Active Directory - Direct, _directConnect=true, _name=Active Directory, _status=released, _type=SourceConfig, __text=\n\t}} ` -DirectConnect true ` -FileUpload false ` -UploadedFiles [] ` - -ConnectorMetadata {supportedUI=EXTJS} + -ConnectorMetadata {supportedUI=EXTJS} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelatedGovernanceEvent.md index 25af408f48ac..19bf2da5d069 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelatedGovernanceEvent.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelatedGovernanceEvent.md @@ -32,8 +32,8 @@ $CorrelatedGovernanceEvent = Initialize-PSSailpoint.V2024CorrelatedGovernanceEve -Dt 2019-03-08T22:37:33.901Z ` -Type certification ` -GovernanceId 2c91808a77ff216301782327a50f09bf ` - -Owners [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Owners [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` -DecisionMaker null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelationConfigAttributeAssignmentsInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelationConfigAttributeAssignmentsInner.md index 351a865ce1af..8e90c549b2c1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelationConfigAttributeAssignmentsInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelationConfigAttributeAssignmentsInner.md @@ -34,7 +34,7 @@ $CorrelationConfigAttributeAssignmentsInner = Initialize-PSSailpoint.V2024Correl -Complex false ` -IgnoreCase false ` -MatchMode ANYWHERE ` - -FilterString first_name == "John" + -FilterString first_name == "John" ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateExternalExecuteWorkflowRequest.md index bb0391d790e5..7e072c545604 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateExternalExecuteWorkflowRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateExternalExecuteWorkflowRequest.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$CreateExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V2024CreateExternalExecuteWorkflowRequest -VarInput {customAttribute1=value1, customAttribute2=value2} +$CreateExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V2024CreateExternalExecuteWorkflowRequest -VarInput {customAttribute1=value1, customAttribute2=value2} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateFormInstanceRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateFormInstanceRequest.md index 506c5303bbb5..72e12a744f09 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateFormInstanceRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateFormInstanceRequest.md @@ -32,7 +32,7 @@ Name | Type | Description | Notes $CreateFormInstanceRequest = Initialize-PSSailpoint.V2024CreateFormInstanceRequest -CreatedBy null ` -Expire 2023-08-12T20:14:57.74486Z ` -FormDefinitionId 00000000-0000-0000-0000-000000000000 ` - -FormInput {input1=Sales} ` + -FormInput {input1=Sales} ` -Recipients null ` -StandAloneForm false ` -State ASSIGNED ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md index 98864c447128..876a93080c62 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateSavedSearchRequest.md @@ -37,10 +37,10 @@ $CreateSavedSearchRequest = Initialize-PSSailpoint.V2024CreateSavedSearchRequest -Created 2018-06-25T20:22:28.104Z ` -Modified 2018-06-25T20:22:28.104Z ` -Indices [identities] ` - -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` -Query @accounts(disabled:true) ` -Fields [disabled] ` - -OrderBy {identity=[lastName, firstName], role=[name]} ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` -Sort [displayName] ` -Filters null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateWorkflowRequest.md index fe603ef2296a..7974a58afa83 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CreateWorkflowRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CreateWorkflowRequest.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes ```powershell $CreateWorkflowRequest = Initialize-PSSailpoint.V2024CreateWorkflowRequest -Name Send Email ` -Owner null ` - -Description Send an email to the identity who's attributes changed. ` + -Description Send an email to the identity who's attributes changed. ` -Definition null ` -Enabled false ` -Trigger null diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/DataSegment.md b/docs/tools/sdk/powershell/Reference/V2024/Models/DataSegment.md index 67f2c3e2a1af..db2de172ccf1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/DataSegment.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/DataSegment.md @@ -37,8 +37,8 @@ $DataSegment = Initialize-PSSailpoint.V2024DataSegment -Id 0f11f2a4-7c94-4bf3-a -Created 2020-01-01T00:00Z ` -Modified 2020-01-01T00:00Z ` -Description This segment represents xyz ` - -Scopes [{scope=ENTITLEMENT, visibility=SELECTION, scopeFilter=null, scopeSelection=[{type=ENTITLEMENT, id=34d73f611449463ea4fdcf02cda0c397}]}] ` - -MemberSelection [{type=IDENTITY, id=29cb6c061da843ea8be4b3125f248f2a}, {type=IDENTITY, id=f7b1b8a35fed4fd4ad2982014e137e19}] ` + -Scopes [{scope=ENTITLEMENT, visibility=SELECTION, scopeFilter=null, scopeSelection=[{type=ENTITLEMENT, id=34d73f611449463ea4fdcf02cda0c397}]}] ` + -MemberSelection [{type=IDENTITY, id=29cb6c061da843ea8be4b3125f248f2a}, {type=IDENTITY, id=f7b1b8a35fed4fd4ad2982014e137e19}] ` -MemberFilter null ` -Membership null ` -Enabled true ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompare.md b/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompare.md index 963b25cf496c..bac4f5ccc839 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompare.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompare.md @@ -34,7 +34,7 @@ $DateCompare = Initialize-PSSailpoint.V2024DateCompare -FirstDate null ` -PositiveCondition true ` -NegativeCondition false ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompareFirstDate.md b/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompareFirstDate.md index e9316a3571ca..6021a68b0baf 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompareFirstDate.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompareFirstDate.md @@ -37,10 +37,10 @@ $DateCompareFirstDate = Initialize-PSSailpoint.V2024DateCompareFirstDate -Sourc -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` -InputFormat null ` -OutputFormat null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompareSecondDate.md b/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompareSecondDate.md index 6a8fb3771db7..7759e0482ed7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompareSecondDate.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/DateCompareSecondDate.md @@ -37,10 +37,10 @@ $DateCompareSecondDate = Initialize-PSSailpoint.V2024DateCompareSecondDate -Sou -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` -InputFormat null ` -OutputFormat null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/DateFormat.md b/docs/tools/sdk/powershell/Reference/V2024/Models/DateFormat.md index eb96ada7ea64..efd5871db126 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/DateFormat.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/DateFormat.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $DateFormat = Initialize-PSSailpoint.V2024DateFormat -InputFormat null ` -OutputFormat null ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/DateMath.md b/docs/tools/sdk/powershell/Reference/V2024/Models/DateMath.md index c54041b09eb8..ebb3aed3e392 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/DateMath.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/DateMath.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $DateMath = Initialize-PSSailpoint.V2024DateMath -Expression now+1w ` -RoundUp false ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/DecomposeDiacriticalMarks.md b/docs/tools/sdk/powershell/Reference/V2024/Models/DecomposeDiacriticalMarks.md index f94e994e97ab..f6283308d730 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/DecomposeDiacriticalMarks.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/DecomposeDiacriticalMarks.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $DecomposeDiacriticalMarks = Initialize-PSSailpoint.V2024DecomposeDiacriticalMarks -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/E164phone.md b/docs/tools/sdk/powershell/Reference/V2024/Models/E164phone.md index e3f234812eed..22b4a89ef57c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/E164phone.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/E164phone.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $E164phone = Initialize-PSSailpoint.V2024E164phone -DefaultRegion US ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement.md index f94bc7a62be2..ebe89ef6570a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement.md @@ -38,15 +38,15 @@ Name | Type | Description | Notes $Entitlement = Initialize-PSSailpoint.V2024Entitlement -Id 2c91808874ff91550175097daaec161c ` -Name LauncherTest2 ` -Attribute memberOf ` - -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` -SourceSchemaObjectType group ` - -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` -Privileged true ` -CloudGoverned true ` -Created 2020-10-08T18:33:52.029Z ` -Modified 2020-10-08T18:33:52.029Z ` -Source null ` - -Attributes {fieldName=fieldValue} ` + -Attributes {fieldName=fieldValue} ` -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` -DirectPermissions null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1.md index 1d1282fcd567..240d2c46a078 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1.md @@ -44,13 +44,13 @@ $Entitlement1 = Initialize-PSSailpoint.V2024Entitlement1 -Id 2c91808874ff915501 -Created 2020-10-08T18:33:52.029Z ` -Modified 2020-10-08T18:33:52.029Z ` -Attribute memberOf ` - -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` -SourceSchemaObjectType group ` -Privileged true ` -CloudGoverned true ` - -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` -Requestable true ` - -Attributes {fieldName=fieldValue} ` + -Attributes {fieldName=fieldValue} ` -Source null ` -Owner null ` -DirectPermissions null ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1AccessModelMetadata.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1AccessModelMetadata.md index 64e521932a2b..79fb39b3afa0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1AccessModelMetadata.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1AccessModelMetadata.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Entitlement1AccessModelMetadata = Initialize-PSSailpoint.V2024Entitlement1AccessModelMetadata -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] +$Entitlement1AccessModelMetadata = Initialize-PSSailpoint.V2024Entitlement1AccessModelMetadata -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementBulkUpdateRequest.md index 6e208c40053f..88acf54cc3f2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementBulkUpdateRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementBulkUpdateRequest.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $EntitlementBulkUpdateRequest = Initialize-PSSailpoint.V2024EntitlementBulkUpdateRequest -EntitlementIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] ` - -JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}] + -JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementDto.md b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementDto.md index 1d61a9f81807..4d47aa296478 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementDto.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementDto.md @@ -38,9 +38,9 @@ $EntitlementDto = Initialize-PSSailpoint.V2024EntitlementDto -Id id12345 ` -Created 2015-05-28T14:07:17Z ` -Modified 2015-05-28T14:07:17Z ` -Attribute authorizationType ` - -Value CN=Users,dc=sailpoint,dc=com ` + -Value CN=Users,dc=sailpoint,dc=com ` -Description Active Directory DC ` - -Attributes {GroupType=Security, sAMAccountName=Buyer} ` + -Attributes {GroupType=Security, sAMAccountName=Buyer} ` -SourceSchemaObjectType group ` -Privileged false ` -CloudGoverned false ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRef.md index 52a2e4566ad1..2fd3dcfdd3c8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRef.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRef.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $EntitlementRef = Initialize-PSSailpoint.V2024EntitlementRef -Type ENTITLEMENT ` -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRef1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRef1.md index 84e50bab7c5d..eaa147977ab2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRef1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRef1.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $EntitlementRef1 = Initialize-PSSailpoint.V2024EntitlementRef1 -Type ENTITLEMENT ` -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementSummary.md b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementSummary.md index 2dd76af2a23c..31bb723d6ef6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementSummary.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementSummary.md @@ -39,7 +39,7 @@ $EntitlementSummary = Initialize-PSSailpoint.V2024EntitlementSummary -Id 2c9180 -Type ENTITLEMENT ` -Privileged false ` -Attribute memberOf ` - -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` -Standalone false ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Event.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Event.md index 94db5d100cb2..46c567f651cf 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Event.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Event.md @@ -50,7 +50,7 @@ $ModelEvent = Initialize-PSSailpoint.V2024ModelEvent -Id 2c91808375d8e80a0175e1 -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` -IpAddress 52.52.97.85 ` -Details 73b65dfbed1842548c207432a18c84b0 ` - -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` + -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` -Objects null ` -Operation ADD ` -Status PASSED ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/EventAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/Models/EventAttributes.md index f4edbaf67b2d..3902c52984b5 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/EventAttributes.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/EventAttributes.md @@ -26,8 +26,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $EventAttributes = Initialize-PSSailpoint.V2024EventAttributes -Id idn:identity-attributes-changed ` - -VarFilter $.changes[?(@.attribute == 'manager')] ` - -Description Triggered when an identity's manager attribute changes ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` + -Description Triggered when an identity's manager attribute changes ` -AttributeToFilter LifecycleState ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/EventDocument.md b/docs/tools/sdk/powershell/Reference/V2024/Models/EventDocument.md index cc70a390ac49..f84f1e0ead4a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/EventDocument.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/EventDocument.md @@ -50,7 +50,7 @@ $EventDocument = Initialize-PSSailpoint.V2024EventDocument -Id 2c91808375d8e80a -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` -IpAddress 52.52.97.85 ` -Details 73b65dfbed1842548c207432a18c84b0 ` - -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` + -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` -Objects null ` -Operation ADD ` -Status PASSED ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteria.md index 6bc61f76487a..3bc6b0c61ea5 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteria.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteria.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ExceptionCriteria = Initialize-PSSailpoint.V2024ExceptionCriteria -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] +$ExceptionCriteria = Initialize-PSSailpoint.V2024ExceptionCriteria -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteriaAccess.md index 6c05eb5cf07b..a640c7091bdd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteriaAccess.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteriaAccess.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes ```powershell $ExceptionCriteriaAccess = Initialize-PSSailpoint.V2024ExceptionCriteriaAccess -Type null ` -Id 2c91808568c529c60168cca6f90c1313 ` - -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` -Existing true ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteriaCriteriaListInner.md index d58b7d9e9994..6ba778becea1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteriaCriteriaListInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ExceptionCriteriaCriteriaListInner.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes ```powershell $ExceptionCriteriaCriteriaListInner = Initialize-PSSailpoint.V2024ExceptionCriteriaCriteriaListInner -Type ENTITLEMENT ` -Id 2c91808568c529c60168cca6f90c1313 ` - -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` -Existing true ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ExportOptions.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ExportOptions.md index f516f324f075..da02eefd5b3a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ExportOptions.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ExportOptions.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $ExportOptions = Initialize-PSSailpoint.V2024ExportOptions -ExcludeTypes null ` -IncludeTypes null ` - -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ExportPayload.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ExportPayload.md index 4817dd8a7e54..08727b0825a9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ExportPayload.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ExportPayload.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $ExportPayload = Initialize-PSSailpoint.V2024ExportPayload -Description Export Job 1 Test ` -ExcludeTypes null ` -IncludeTypes null ` - -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/FieldDetailsDto.md b/docs/tools/sdk/powershell/Reference/V2024/Models/FieldDetailsDto.md index b132f5971aa5..7c2be36d0fd8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/FieldDetailsDto.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/FieldDetailsDto.md @@ -28,8 +28,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $FieldDetailsDto = Initialize-PSSailpoint.V2024FieldDetailsDto -Name userName ` - -Transform {type=rule, attributes={name=Create Unique LDAP Attribute}} ` - -Attributes {template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true} ` + -Transform {type=rule, attributes={name=Create Unique LDAP Attribute}} ` + -Attributes {template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true} ` -IsRequired false ` -Type string ` -IsMultiValued false diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/FirstValid.md b/docs/tools/sdk/powershell/Reference/V2024/Models/FirstValid.md index 954428cb18b2..dfa41bf3faa4 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/FirstValid.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/FirstValid.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$FirstValid = Initialize-PSSailpoint.V2024FirstValid -Values [{attributes={sourceName=Active Directory, attributeName=sAMAccountName}, type=accountAttribute}, {attributes={sourceName=Okta, attributeName=login}, type=accountAttribute}, {attributes={sourceName=HR Source, attributeName=employeeID}, type=accountAttribute}] ` +$FirstValid = Initialize-PSSailpoint.V2024FirstValid -Values [{attributes={sourceName=Active Directory, attributeName=sAMAccountName}, type=accountAttribute}, {attributes={sourceName=Okta, attributeName=login}, type=accountAttribute}, {attributes={sourceName=HR Source, attributeName=employeeID}, type=accountAttribute}] ` -IgnoreErrors false ` -RequiresPeriodicRefresh false ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/FormDefinitionDynamicSchemaResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/FormDefinitionDynamicSchemaResponse.md index b7e55d1b233a..3221b853cb09 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/FormDefinitionDynamicSchemaResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/FormDefinitionDynamicSchemaResponse.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$FormDefinitionDynamicSchemaResponse = Initialize-PSSailpoint.V2024FormDefinitionDynamicSchemaResponse -OutputSchema {outputSchema={$schema=https://json-schema.org/draft/2020-12/schema, additionalProperties=false, properties={firstName={title=First Name, type=string}, fullName={title=Full Name, type=string}, lastName={title=Last Name, type=string}, startDate={format=date-time, title=Start Date, type=string}}, type=object}} +$FormDefinitionDynamicSchemaResponse = Initialize-PSSailpoint.V2024FormDefinitionDynamicSchemaResponse -OutputSchema {outputSchema={$schema=https://json-schema.org/draft/2020-12/schema, additionalProperties=false, properties={firstName={title=First Name, type=string}, fullName={title=Full Name, type=string}, lastName={title=Last Name, type=string}, startDate={format=date-time, title=Start Date, type=string}}, type=object}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/FormElement.md b/docs/tools/sdk/powershell/Reference/V2024/Models/FormElement.md index 747c28dc3598..2ee253608375 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/FormElement.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/FormElement.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes ```powershell $FormElement = Initialize-PSSailpoint.V2024FormElement -Id 00000000-0000-0000-0000-000000000000 ` -ElementType TEXT ` - -Config {label=Department} ` + -Config {label=Department} ` -Key department ` -Validations null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/FormInstanceResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/FormInstanceResponse.md index 23ec9d461614..f09e8d0b6345 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/FormInstanceResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/FormInstanceResponse.md @@ -40,11 +40,11 @@ $FormInstanceResponse = Initialize-PSSailpoint.V2024FormInstanceResponse -Creat -CreatedBy null ` -Expire 2023-08-12T20:14:57.74486Z ` -FormConditions null ` - -FormData {department=Engineering} ` + -FormData {department=Engineering} ` -FormDefinitionId 49841cb8-00a5-4fbd-9888-8bbb28d48331 ` -FormElements null ` -FormErrors null ` - -FormInput {input1=Sales} ` + -FormInput {input1=Sales} ` -Id 06a2d961-07fa-44d1-8d0a-2f6470e30fd2 ` -Modified 2023-07-12T20:14:57.744860Z ` -Recipients null ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md index e3cd7da79e4b..8441ea2dbb8e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -46,8 +46,8 @@ $GetHistoricalIdentityEvents200ResponseInner = Initialize-PSSailpoint.V2024GetHi -CertificationId 2c91808a77ff216301782327a50f09bf ` -CertificationName Cert name ` -SignedDate 2019-03-08T22:37:33.901Z ` - -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` -Signer null ` -Account null ` -StatusChange null diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md index 264e19008159..c41382ae0f0d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md @@ -32,10 +32,10 @@ Name | Type | Description | Notes ```powershell $GetRoleAssignments200ResponseInner = Initialize-PSSailpoint.V2024GetRoleAssignments200ResponseInner -Id 1cbb0705b38c4226b1334eadd8874086 ` -Role null ` - -Comments I'm a new Engineer and need this role to do my work ` + -Comments I'm a new Engineer and need this role to do my work ` -AssignmentSource UI ` -Assigner null ` - -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` + -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` -AssignmentContext null ` -AccountTargets null ` -RemoveDate Wed Feb 14 10:58:42 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ISO3166.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ISO3166.md index 14063e859986..ce85003bc9a3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ISO3166.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ISO3166.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $ISO3166 = Initialize-PSSailpoint.V2024ISO3166 -Format alpha2 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Identity.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Identity.md index 218314be912d..bbed9268c734 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Identity.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Identity.md @@ -45,7 +45,7 @@ $Identity = Initialize-PSSailpoint.V2024Identity -Id 01f04e428c484542a241dc89c3 -ManagerRef null ` -IsManager true ` -LastRefresh 2020-11-22T15:42:31.123Z ` - -Attributes {uid=86754, firstname=Walter, cloudStatus=UNREGISTERED, displayName=Walter White, identificationNumber=86754, lastSyncDate=1470348809380, email=walter.white@example.com, lastname=White} ` + -Attributes {uid=86754, firstname=Walter, cloudStatus=UNREGISTERED, displayName=Walter White, identificationNumber=86754, lastSyncDate=1470348809380, email=walter.white@example.com, lastname=White} ` -LifecycleState null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAccess.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAccess.md index af2be409f047..c12cd6d52179 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAccess.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAccess.md @@ -44,7 +44,7 @@ $IdentityAccess = Initialize-PSSailpoint.V2024IdentityAccess -Id 2c91808568c529 -Revocable null ` -Privileged false ` -Attribute memberOf ` - -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` -Standalone false ` -Disabled null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAssociationDetailsAssociationDetailsInner.md index 066acd0f48d2..127fa0a48b40 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAssociationDetailsAssociationDetailsInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAssociationDetailsAssociationDetailsInner.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityAssociationDetailsAssociationDetailsInner = Initialize-PSSailpoint.V2024IdentityAssociationDetailsAssociationDetailsInner -AssociationType CAMPAIGN_OWNER ` - -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=CAMPAIGN_CAMPAIGNER} + -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=CAMPAIGN_CAMPAIGNER} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttribute1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttribute1.md index b293e66398b8..8f2773b4dbc0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttribute1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttribute1.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $IdentityAttribute1 = Initialize-PSSailpoint.V2024IdentityAttribute1 -Name email ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md index dc79b5362397..82aba545b9be 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'V2024Ident Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**Enabled** | **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] **AttributeTransforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md index 13b767113dba..1c0ccc4054a4 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'V2024Id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] +**IdentityAttributeName** | **String** | Name of the identity attribute. | [optional] **TransformDefinition** | [**TransformDefinition**](transform-definition) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCertified.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCertified.md index c43a65806b09..d08b78950e0a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCertified.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCertified.md @@ -32,8 +32,8 @@ Name | Type | Description | Notes $IdentityCertified = Initialize-PSSailpoint.V2024IdentityCertified -CertificationId 2c91808a77ff216301782327a50f09bf ` -CertificationName Cert name ` -SignedDate 2019-03-08T22:37:33.901Z ` - -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` -Signer null ` -EventType IdentityCertified ` -Dt 2019-03-08T22:37:33.901Z diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCreated.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCreated.md index 7bac4e20eaf1..49025bb792ad 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCreated.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCreated.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityCreated = Initialize-PSSailpoint.V2024IdentityCreated -Identity null ` - -Attributes {firstname=John} + -Attributes {firstname=John} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityDeleted.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityDeleted.md index fd6d2344cc65..efb0e4b08233 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityDeleted.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityDeleted.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityDeleted = Initialize-PSSailpoint.V2024IdentityDeleted -Identity null ` - -Attributes {firstname=John} + -Attributes {firstname=John} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityDocument.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityDocument.md index 046e6833eb9b..31d1e8787fde 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityDocument.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityDocument.md @@ -77,7 +77,7 @@ $IdentityDocument = Initialize-PSSailpoint.V2024IdentityDocument -Id 2c91808568 -IsManager false ` -IdentityProfile null ` -Source null ` - -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` + -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` -Disabled false ` -Locked false ` -ProcessingState ERROR ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md index 8df214ad6110..f4e7a125e75f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'V Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | Task result ID. | [optional] -**ReportName** | **String** | Report name. | [optional] +**TaskResultId** | **String** | The id of the task result. | [optional] +**ReportName** | **String** | The name of the report. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityHistoryResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityHistoryResponse.md index 5ef35dc8fc53..ec8627053385 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityHistoryResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityHistoryResponse.md @@ -31,8 +31,8 @@ $IdentityHistoryResponse = Initialize-PSSailpoint.V2024IdentityHistoryResponse -DisplayName Adam Zampa ` -Snapshot 2007-03-01T13:00:00.000Z ` -DeletedDate 2007-03-01T13:00:00.000Z ` - -AccessItemCount {app=0, role=2, entitlement=4, accessProfile=3, account=1} ` - -Attributes {jobTitle=HR Manager, location=NYC, firstname=Adam, lastname=Zampa, department=HR} + -AccessItemCount {app=0, role=2, entitlement=4, accessProfile=3, account=1} ` + -Attributes {jobTitle=HR Manager, location=NYC, firstname=Adam, lastname=Zampa, department=HR} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md index b8421b64da89..fa239996b01e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityOwnershipAssociationDetailsAssociationDetailsInner = Initialize-PSSailpoint.V2024IdentityOwnershipAssociationDetailsAssociationDetailsInner -AssociationType ROLE_OWNER ` - -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=ROLE} + -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=ROLE} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md index bca39a3f36a0..2c14ca9eb361 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | Identity profile's description. | [optional] +**Description** | **String** | The description of the Identity Profile. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | Identity profile's priority. | [optional] +**Priority** | **Int64** | The priority for an Identity Profile. | [optional] **AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] -**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] +**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md index 07ac75fe8ec7..783b99110147 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] -**Id** | **String** | Authoritative source's ID. | [optional] -**Name** | **String** | Authoritative source's name. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] +**Id** | **String** | ID of the object to which this reference applies | [optional] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md index 5e543c4c126e..dd76789ffe0a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'V2024Ide Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Owner's object type. | [optional] -**Id** | **String** | Owner's ID. | [optional] -**Name** | **String** | Owner's name. | [optional] +**Type** | **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] +**Id** | **String** | ID of the object to which this reference applies | [optional] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentitySyncPayload.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentitySyncPayload.md index 500070fcfcf9..2849f484d10e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentitySyncPayload.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentitySyncPayload.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentitySyncPayload = Initialize-PSSailpoint.V2024IdentitySyncPayload -Type SYNCHRONIZE_IDENTITY_ATTRIBUTES ` - -DataJson {"identityId":"2c918083746f642c01746f990884012a"} + -DataJson {"identityId":"2c918083746f642c01746f990884012a"} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess.md index a57b9e8f73bd..5a523a05a6c6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityWithNewAccess = Initialize-PSSailpoint.V2024IdentityWithNewAccess -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}] + -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}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess1.md index f930f41dccaa..127fea73b070 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccess1.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $IdentityWithNewAccess1 = Initialize-PSSailpoint.V2024IdentityWithNewAccess1 -IdentityId 2c91809050db617d0150e0bf3215385e ` -AccessRefs null ` - -ClientMetadata {clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} + -ClientMetadata {clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md index 7e66f8eecc0e..a5034fb60e11 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityWithNewAccessAccessRefsInner.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $IdentityWithNewAccessAccessRefsInner = Initialize-PSSailpoint.V2024IdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT ` -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ImportOptions.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ImportOptions.md index 3db3f604f2a0..9178a43a04d7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ImportOptions.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ImportOptions.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes ```powershell $ImportOptions = Initialize-PSSailpoint.V2024ImportOptions -ExcludeTypes null ` -IncludeTypes null ` - -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} ` + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} ` -DefaultReferences null ` -ExcludeBackup false ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IndexOf.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IndexOf.md index 2eae2688d8e5..35ca84b74571 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IndexOf.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IndexOf.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $IndexOf = Initialize-PSSailpoint.V2024IndexOf -Substring admin_ ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/InnerHit.md b/docs/tools/sdk/powershell/Reference/V2024/Models/InnerHit.md index 73970fa18d8f..66ac10ee4eb3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/InnerHit.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/InnerHit.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$InnerHit = Initialize-PSSailpoint.V2024InnerHit -Query source.name:\"Active Directory\" ` +$InnerHit = Initialize-PSSailpoint.V2024InnerHit -Query source.name:\"Active Directory\" ` -Type access ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Invocation.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Invocation.md index 4e1886336e59..7926cb1fe289 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Invocation.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Invocation.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $Invocation = Initialize-PSSailpoint.V2024Invocation -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` -TriggerId idn:access-requested ` -Secret 0f979022-08be-44f2-b6f9-7393ec73ed9b ` - -ContentJson {workflowId=1234} + -ContentJson {workflowId=1234} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/KbaAnswerResponseItem.md index 6934ecae43c8..d46c54f0b335 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/KbaAnswerResponseItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/KbaAnswerResponseItem.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $KbaAnswerResponseItem = Initialize-PSSailpoint.V2024KbaAnswerResponseItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` - -Question [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -Question [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` -HasAnswer true ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/KbaQuestion.md b/docs/tools/sdk/powershell/Reference/V2024/Models/KbaQuestion.md index 915605be90ba..2014256e2391 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/KbaQuestion.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/KbaQuestion.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $KbaQuestion = Initialize-PSSailpoint.V2024KbaQuestion -Id 143cfd3b-c23f-426b-ae5f-d3db06fa5919 ` - -Text [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -Text [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` -HasAnswer true ` -NumAnswers 5 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/LeftPad.md b/docs/tools/sdk/powershell/Reference/V2024/Models/LeftPad.md index b96ec8d7b420..df28f41d24d5 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/LeftPad.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/LeftPad.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $LeftPad = Initialize-PSSailpoint.V2024LeftPad -Length 4 ` -Padding 0 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ListCompleteWorkflowLibrary200ResponseInner.md index ba29c9c2d14f..b339879948b9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ListCompleteWorkflowLibrary200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -38,7 +38,7 @@ $ListCompleteWorkflowLibrary200ResponseInner = Initialize-PSSailpoint.V2024ListC -Name Compare Boolean Values ` -Type OPERATOR ` -Description Compare two boolean values and decide what happens based on the result. ` - -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ` + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ` -ExampleOutput null ` -Deprecated null ` -DeprecatedBy null ` @@ -46,7 +46,7 @@ $ListCompleteWorkflowLibrary200ResponseInner = Initialize-PSSailpoint.V2024ListC -IsSimulationEnabled null ` -IsDynamicSchema false ` -OutputSchema null ` - -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ListFormElementDataByElementIDResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ListFormElementDataByElementIDResponse.md index e3601c0142b9..011b4087d682 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ListFormElementDataByElementIDResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ListFormElementDataByElementIDResponse.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ListFormElementDataByElementIDResponse = Initialize-PSSailpoint.V2024ListFormElementDataByElementIDResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} +$ListFormElementDataByElementIDResponse = Initialize-PSSailpoint.V2024ListFormElementDataByElementIDResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/LoadEntitlementTask.md b/docs/tools/sdk/powershell/Reference/V2024/Models/LoadEntitlementTask.md index b7fe502bdcdb..030e2f270660 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/LoadEntitlementTask.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/LoadEntitlementTask.md @@ -34,7 +34,7 @@ $LoadEntitlementTask = Initialize-PSSailpoint.V2024LoadEntitlementTask -Id ef38 -Description Aggregate from the specified application ` -Launcher John Doe ` -Created 2020-07-11T21:23:15Z ` - -Returns [{displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_CREATED, attributeName=groupsCreated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_UPDATED, attributeName=groupsUpdated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_DELETED, attributeName=groupsDeleted}] + -Returns [{displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_CREATED, attributeName=groupsCreated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_UPDATED, attributeName=groupsUpdated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_DELETED, attributeName=groupsDeleted}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTask.md b/docs/tools/sdk/powershell/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTask.md index e528fc48ee9b..5a6d76848d55 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTask.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/LoadUncorrelatedAccountsTaskTask.md @@ -48,7 +48,7 @@ $LoadUncorrelatedAccountsTaskTask = Initialize-PSSailpoint.V2024LoadUncorrelated -Messages [] ` -Progress Initializing... ` -Attributes null ` - -Returns [{displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IGNORED, attributeName=correlationFailures}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_FAILURES, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION__CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED, attributeName=groupsCreated}] + -Returns [{displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IGNORED, attributeName=correlationFailures}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_FAILURES, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION__CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED, attributeName=groupsCreated}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Lookup.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Lookup.md index 6df7bcb49e2a..6e2310f79255 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Lookup.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Lookup.md @@ -24,9 +24,9 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Lookup = Initialize-PSSailpoint.V2024Lookup -Table {USA=Americas, FRA=EMEA, AUS=APAC, default=Unknown Region} ` +$Lookup = Initialize-PSSailpoint.V2024Lookup -Table {USA=Americas, FRA=EMEA, AUS=APAC, default=Unknown Region} ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Lower.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Lower.md index b7490f438b79..c62473317646 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Lower.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Lower.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Lower = Initialize-PSSailpoint.V2024Lower -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/MachineAccount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/MachineAccount.md deleted file mode 100644 index a17ab9d5bc5a..000000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/MachineAccount.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -id: v2024-machine-account -title: MachineAccount -pagination_label: MachineAccount -sidebar_label: MachineAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MachineAccount', 'V2024MachineAccount'] -slug: /tools/sdk/powershell/v2024/models/machine-account -tags: ['SDK', 'Software Development Kit', 'MachineAccount', 'V2024MachineAccount'] ---- - - -# MachineAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | System-generated unique ID of the Object | [optional] [readonly] -**Name** | **String** | Name of the Object | [required] -**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] -**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | A description of the machine account | [optional] -**NativeIdentity** | **String** | The unique ID of the machine account generated by the source system | [required] -**Uuid** | **String** | The unique ID of the account as determined by the account schema | [optional] -**ClassificationMethod** | **Enum** [ "SOURCE", "CRITERIA", "DISCOVERY", "MANUAL" ] | Classification Method | [required] -**MachineIdentity** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The machine identity this account is associated with | [optional] -**OwnerIdentity** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The identity who owns this account. | [optional] -**AccessType** | **String** | The connection type of the source this account is from | [optional] -**Subtype** | **String** | The sub-type | [optional] -**Environment** | **String** | Environment | [optional] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Custom attributes specific to the machine account | [optional] -**ConnectorAttributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The connector attributes for the account | [required] -**ManuallyCorrelated** | **Boolean** | Indicates if the account has been manually correlated to an identity | [optional] [default to $false] -**ManuallyEdited** | **Boolean** | Indicates if the account has been manually edited | [required][default to $false] -**Locked** | **Boolean** | Indicates if the account is currently locked | [required] -**Enabled** | **Boolean** | Indicates if the account is enabled | [required][default to $false] -**HasEntitlements** | **Boolean** | Indicates if the account has entitlements | [required][default to $true] -**Source** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The source this machine account belongs to. | [required] - -## Examples - -- Prepare the resource -```powershell -$MachineAccount = Initialize-PSSailpoint.V2024MachineAccount -Id id12345 ` - -Name aName ` - -Created 2015-05-28T14:07:17Z ` - -Modified 2015-05-28T14:07:17Z ` - -Description Service account for Active Directory ` - -NativeIdentity 552775 ` - -Uuid {b0dce506-d6d4-44d2-8a32-d9a5b21fb175} ` - -ClassificationMethod SOURCE ` - -MachineIdentity {id=1540e5a4-6c2e-4bf1-b88e-c08cae0696e9, type=MACHINE_IDENTITY, name=SVC_ADService} ` - -OwnerIdentity {id=2c918084660f45d6016617daa9210584, type=IDENTITY, name=Adam Kennedy} ` - -AccessType direct ` - -Subtype null ` - -Environment TEST ` - -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` - -ConnectorAttributes {mail=machine-178@sailpoint.com, givenName=Support, displayName=SailPoint Support} ` - -ManuallyCorrelated true ` - -ManuallyEdited true ` - -Locked false ` - -Enabled false ` - -HasEntitlements false ` - -Source {id=8d3e0094e99445de98eef6c75e25jc04, type=SOURCE, name=Active Directory} -``` - -- Convert the resource to JSON -```powershell -$MachineAccount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/MachineIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/Models/MachineIdentity.md deleted file mode 100644 index c7f1be00f130..000000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/MachineIdentity.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: v2024-machine-identity -title: MachineIdentity -pagination_label: MachineIdentity -sidebar_label: MachineIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MachineIdentity', 'V2024MachineIdentity'] -slug: /tools/sdk/powershell/v2024/models/machine-identity -tags: ['SDK', 'Software Development Kit', 'MachineIdentity', 'V2024MachineIdentity'] ---- - - -# MachineIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | System-generated unique ID of the Object | [optional] [readonly] -**Name** | **String** | Name of the Object | [required] -**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] -**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**BusinessApplication** | **String** | The business application that the identity represents | [required] -**Description** | **String** | Description of machine identity | [optional] -**ManuallyEdited** | **Boolean** | Indicates if the machine identity has been manually edited | [optional] [default to $false] -**Attributes** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A map of custom machine identity attributes | [optional] - -## Examples - -- Prepare the resource -```powershell -$MachineIdentity = Initialize-PSSailpoint.V2024MachineIdentity -Id id12345 ` - -Name aName ` - -Created 2015-05-28T14:07:17Z ` - -Modified 2015-05-28T14:07:17Z ` - -BusinessApplication ADService ` - -Description ` - -ManuallyEdited true ` - -Attributes {"Region":"EU"} -``` - -- Convert the resource to JSON -```powershell -$MachineIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/MailFromAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/Models/MailFromAttributes.md index 72742c62935b..d833c9c865da 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/MailFromAttributes.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/MailFromAttributes.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $MailFromAttributes = Initialize-PSSailpoint.V2024MailFromAttributes -Identity bob.smith@sailpoint.com ` -MailFromDomain foo.sailpoint.com ` -MxRecord 10 feedback-smtp.us-east-1.amazonses.com ` - -TxtRecord v=spf1 include:amazonses.com ~all ` + -TxtRecord v=spf1 include:amazonses.com ~all ` -MailFromDomainStatus PENDING ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClientStatus.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClientStatus.md index 87eb493c32b8..022be1c79e3d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClientStatus.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClientStatus.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ManagedClientStatus = Initialize-PSSailpoint.V2024ManagedClientStatus -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=, state=null, status=NORMAL, uuid=null, product=idn, va_version=null, platform_version=2, os_version=2345.3.1, os_type=flatcar, hypervisor=unknown} ` +$ManagedClientStatus = Initialize-PSSailpoint.V2024ManagedClientStatus -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=, state=null, status=NORMAL, uuid=null, product=idn, va_version=null, platform_version=2, os_version=2345.3.1, os_type=flatcar, hypervisor=unknown} ` -Status null ` -Type null ` -Timestamp 2020-01-01T00:00Z diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md index ac75575944da..380ae513854d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md @@ -51,7 +51,7 @@ $ManagedCluster = Initialize-PSSailpoint.V2024ManagedCluster -Id e1ff7bb24c9342 -Pod megapod-useast1 ` -Org denali ` -Type null ` - -Configuration {clusterExternalId=e1ff7bb24c934240bbf55e1aa39e41c5, clusterType=sqsCluster, gmtOffset=-5} ` + -Configuration {clusterExternalId=e1ff7bb24c934240bbf55e1aa39e41c5, clusterType=sqsCluster, gmtOffset=-5} ` -KeyPair null ` -Attributes null ` -Description A short description of the managed cluster. ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterRequest.md index 88b4c35a3868..eb50e6be1e9e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterRequest.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes ```powershell $ManagedClusterRequest = Initialize-PSSailpoint.V2024ManagedClusterRequest -Name Managed Cluster Name ` -Type null ` - -Configuration {clusterExternalId=externalId, ccgVersion=77.0.0} ` + -Configuration {clusterExternalId=externalId, ccgVersion=77.0.0} ` -Description A short description of the managed cluster. ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ManualDiscoverApplications.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ManualDiscoverApplications.md index e3ff86d28730..39a29524fdf5 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ManualDiscoverApplications.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ManualDiscoverApplications.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ManualDiscoverApplications = Initialize-PSSailpoint.V2024ManualDiscoverApplications -File application_name,description -"Sample App","This is a sample description for Sample App." -"Another App","Description for Another App." +"Sample App","This is a sample description for Sample App." +"Another App","Description for Another App." ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/MatchTerm.md b/docs/tools/sdk/powershell/Reference/V2024/Models/MatchTerm.md index 7f926a03daa9..53b8faffd6cd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/MatchTerm.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/MatchTerm.md @@ -32,7 +32,7 @@ $MatchTerm = Initialize-PSSailpoint.V2024MatchTerm -Name mail ` -Op eq ` -Container true ` -And false ` - -Children [{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}] + -Children [{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/MfaDuoConfig.md b/docs/tools/sdk/powershell/Reference/V2024/Models/MfaDuoConfig.md index 8c3c9b4fb99c..6def0e3cda84 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/MfaDuoConfig.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/MfaDuoConfig.md @@ -32,7 +32,7 @@ $MfaDuoConfig = Initialize-PSSailpoint.V2024MfaDuoConfig -MfaMethod duo-web ` -VarHost example.com ` -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` -IdentityAttribute email ` - -ConfigProperties {skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} + -ConfigProperties {skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NameNormalizer.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NameNormalizer.md index 1cc6cd970e98..7e2cb81bd834 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NameNormalizer.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NameNormalizer.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $NameNormalizer = Initialize-PSSailpoint.V2024NameNormalizer -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRecord.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRecord.md index 488922401857..f063f240b2d0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRecord.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRecord.md @@ -42,7 +42,7 @@ $NonEmployeeRecord = Initialize-PSSailpoint.V2024NonEmployeeRecord -Id ef38f943 -Phone 5125555555 ` -Manager jane.doe ` -SourceId 2c91808568c529c60168cca6f90c1313 ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -StartDate 2019-08-23T18:52:59.162Z ` -EndDate 2020-08-23T18:52:59.162Z ` -Modified 2019-08-23T18:52:59.162Z ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequest.md index f4f74d38640e..f8c435d02e28 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequest.md @@ -52,7 +52,7 @@ $NonEmployeeRequest = Initialize-PSSailpoint.V2024NonEmployeeRequest -Id a03036 -Phone 5125555555 ` -Manager jane.doe ` -NonEmployeeSource null ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -ApprovalItems null ` -ApprovalStatus null ` -Comment approved ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestBody.md index 812535ea31f0..7654ea0dc46a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestBody.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestBody.md @@ -38,7 +38,7 @@ $NonEmployeeRequestBody = Initialize-PSSailpoint.V2024NonEmployeeRequestBody -A -Phone 5125555555 ` -Manager jane.doe ` -SourceId 2c91808568c529c60168cca6f90c1313 ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -StartDate 2020-03-24T00:00-05:00 ` -EndDate 2021-03-25T00:00-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index e6ea69959028..54727248f717 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -47,12 +47,12 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee -Phone 5125555555 ` -Manager jane.doe ` -NonEmployeeSource null ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -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/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeSourceWithNECount.md index eb4e7318c2b1..60c1c34c67ed 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeSourceWithNECount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeSourceWithNECount.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes **AccountManagers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] **Modified** | **System.DateTime** | When the request was last modified. | [optional] **Created** | **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] +**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NotificationTemplateContext.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NotificationTemplateContext.md index 1b443927ef73..a1e80480b9b4 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NotificationTemplateContext.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NotificationTemplateContext.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$NotificationTemplateContext = Initialize-PSSailpoint.V2024NotificationTemplateContext -Attributes {productUrl=https://test-org.identitysoon.com, brandingConfigs={default={narrowLogoURL=null, productName=SailPoint, standardLogoURL=null, navigationColor=011E64, actionButtonColor=20B2DE, emailFromAddress=null, activeLinkColor=20B2DE, loginInformationalMessage=null}}} ` +$NotificationTemplateContext = Initialize-PSSailpoint.V2024NotificationTemplateContext -Attributes {productUrl=https://test-org.identitysoon.com, brandingConfigs={default={narrowLogoURL=null, productName=SailPoint, standardLogoURL=null, navigationColor=011E64, actionButtonColor=20B2DE, emailFromAddress=null, activeLinkColor=20B2DE, loginInformationalMessage=null}}} ` -Created 2020-04-15T16:16:47.525Z ` -Modified 2020-04-15T16:16:47.525Z ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md index 043f8bb8d29a..8de4687c40da 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ObjectMappingBulkPatchRequest.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ObjectMappingBulkPatchRequest = Initialize-PSSailpoint.V2024ObjectMappingBulkPatchRequest -Patches {603b1a61-d03d-4ed1-864f-a508fbd1995d=[{op=replace, path=/enabled, value=true}], 00bece34-f50d-4227-8878-76f620b5a971=[{op=replace, path=/targetValue, value=New Target Value}]} +$ObjectMappingBulkPatchRequest = Initialize-PSSailpoint.V2024ObjectMappingBulkPatchRequest -Patches {603b1a61-d03d-4ed1-864f-a508fbd1995d=[{op=replace, path=/enabled, value=true}], 00bece34-f50d-4227-8878-76f620b5a971=[{op=replace, path=/targetValue, value=New Target Value}]} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/OrgConfig.md b/docs/tools/sdk/powershell/Reference/V2024/Models/OrgConfig.md index 4e88b32fa47e..ecfc91ae1fdc 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/OrgConfig.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/OrgConfig.md @@ -35,8 +35,8 @@ $OrgConfig = Initialize-PSSailpoint.V2024OrgConfig -OrgName acme-solar ` -TimeZone America/Toronto ` -LcsChangeHonorsSourceEnableFeature false ` -ArmCustomerId DE38E75A-5FF6-4A65-5DC7-08D64426B09E ` - -ArmSapSystemIdMappings [{sourceId=2c91808c791a94e501792388b0d62659, systemId=1556}, {sourceId=2_2c91808c791a94e501792388b0d62659, systemId=2_1556}, {sourceId=3_2c91808c791a94e501792388b0d62659, systemId=3_1556}] ` - -ArmAuth epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag== ` + -ArmSapSystemIdMappings [{sourceId=2c91808c791a94e501792388b0d62659, systemId=1556}, {sourceId=2_2c91808c791a94e501792388b0d62659, systemId=2_1556}, {sourceId=3_2c91808c791a94e501792388b0d62659, systemId=3_1556}] ` + -ArmAuth epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag== ` -ArmDb EU ` -ArmSsoUrl https://your-arm-sso-url ` -IaiEnableCertificationRecommendations true ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/OriginalRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/OriginalRequest.md index 656b090c9d55..fb32b82a0a0a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/OriginalRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/OriginalRequest.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$OriginalRequest = Initialize-PSSailpoint.V2024OriginalRequest -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` +$OriginalRequest = Initialize-PSSailpoint.V2024OriginalRequest -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -Result null ` -AttributeRequests null ` -Op add ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Outlier.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Outlier.md index 6255f27d03ca..620e50521573 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Outlier.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Outlier.md @@ -38,7 +38,7 @@ $Outlier = Initialize-PSSailpoint.V2024Outlier -Id 5be33d3e-c54d-4ed7-af73-2380 -FirstDetectionDate 2021-05-01T18:40:35.772Z ` -LatestDetectionDate 2021-05-03T18:40:35.772Z ` -Ignored false ` - -Attributes {displayName=John Smith, jobTitle=Software Engineer, department=Engineering} ` + -Attributes {displayName=John Smith, jobTitle=Software Engineer, department=Engineering} ` -Score 0.92 ` -UnignoreType MANUAL ` -UnignoreDate 2021-06-01T18:40:35.772Z ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/OutlierFeatureSummary.md b/docs/tools/sdk/powershell/Reference/V2024/Models/OutlierFeatureSummary.md index d46f4a184e57..3b4495d4a5c8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/OutlierFeatureSummary.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/OutlierFeatureSummary.md @@ -36,7 +36,7 @@ $OutlierFeatureSummary = Initialize-PSSailpoint.V2024OutlierFeatureSummary -Con -FeatureExplanation An identity that has too much rare access has a higher change of becoming a security threat due to the unique access they possess ` -PeerDisplayName Mary Jane ` -PeerIdentityId 9f9d5d53ad0e48fba7352f6da9f1b8gbg ` - -AccessItemReference {displayName=All Rare Entitlements, searchPlaceholder=Search by name or description} + -AccessItemReference {displayName=All Rare Entitlements, searchPlaceholder=Search by name or description} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordChangeRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordChangeRequest.md index 94cf4ecb922a..b3609dc85c31 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordChangeRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordChangeRequest.md @@ -27,9 +27,9 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $PasswordChangeRequest = Initialize-PSSailpoint.V2024PasswordChangeRequest -IdentityId 8a807d4c73c545510173c545f0a002ff ` - -EncryptedPassword XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== ` + -EncryptedPassword XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== ` -PublicKeyId YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 ` - -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -SourceId 8a807d4c73c545510173c545d4b60246 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordInfoAccount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordInfoAccount.md index 199a101ca28a..dd28218079a1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordInfoAccount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordInfoAccount.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$PasswordInfoAccount = Initialize-PSSailpoint.V2024PasswordInfoAccount -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` +$PasswordInfoAccount = Initialize-PSSailpoint.V2024PasswordInfoAccount -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -AccountName Abby.Smith ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordPolicyHoldersDtoInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordPolicyHoldersDtoInner.md index 05324c399cb4..b22085584c82 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordPolicyHoldersDtoInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/PasswordPolicyHoldersDtoInner.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $PasswordPolicyHoldersDtoInner = Initialize-PSSailpoint.V2024PasswordPolicyHoldersDtoInner -PolicyId 2c91808e7d976f3b017d9f5ceae440c8 ` -PolicyName PasswordPolicy Example ` - -Selectors {identityAttr=[{name=displayName, value=Robert}, {name=lastname, value=Juice}]} + -Selectors {identityAttr=[{name=displayName, value=Robert}, {name=lastname, value=Juice}]} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/PreviewDataSourceResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/PreviewDataSourceResponse.md index 0ee60921f65d..ed9c1a46b410 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/PreviewDataSourceResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/PreviewDataSourceResponse.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$PreviewDataSourceResponse = Initialize-PSSailpoint.V2024PreviewDataSourceResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} +$PreviewDataSourceResponse = Initialize-PSSailpoint.V2024PreviewDataSourceResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProcessingDetails.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProcessingDetails.md index faca91c92bc2..00ec01bd5da3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProcessingDetails.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProcessingDetails.md @@ -29,8 +29,8 @@ Name | Type | Description | Notes $ProcessingDetails = Initialize-PSSailpoint.V2024ProcessingDetails -Date 2018-06-25T20:22:28.104Z ` -Stage In Process ` -RetryCount 0 ` - -VarStackTrace <stack trace> ` - -Message <message> + -VarStackTrace ` + -Message ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Product.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Product.md index 80782d437d45..2fcf4d8c999b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Product.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Product.md @@ -44,7 +44,7 @@ $Product = Initialize-PSSailpoint.V2024Product -ProductName idn ` -ProductRight idn:ui:view ` -ApiUrl https://tenant-name.api.identitynow.com ` -Licenses null ` - -Attributes {domain=https://tenant-name.identitynow.com, maxRegisteredUsers=250} ` + -Attributes {domain=https://tenant-name.identitynow.com, maxRegisteredUsers=250} ` -Zone Deployment zone for the Product ` -Status active ` -StatusDateTime 2020-05-19T13:49:37.385Z ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInner.md index c9e140220163..c30224c9ccd2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInner.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ProvisioningCompletedAccountRequestsInner = Initialize-PSSailpoint.V2024ProvisioningCompletedAccountRequestsInner -Source null ` - -AccountId CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com ` + -AccountId CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com ` -AccountOperation Modify ` -ProvisioningResult SUCCESS ` -ProvisioningTarget Corp AD ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md index 89a2fd38cca7..82e1b0e96980 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner = Initialize-PSSailpoint.V2024ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner -AttributeName memberOf ` - -AttributeValue CN=jedi,DC=starwars,DC=com ` + -AttributeValue CN=jedi,DC=starwars,DC=com ` -Operation Add ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig.md index 7fbc9559748f..f981701770cc 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ProvisioningConfig = Initialize-PSSailpoint.V2024ProvisioningConfig -UniversalManager true ` - -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` + -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` -PlanInitializerScript null ` -NoProvisioningRequests true ` -ProvisioningRequestExpiration 7 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig1.md index ae27e220bd19..1b2e4d339275 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig1.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ProvisioningConfig1 = Initialize-PSSailpoint.V2024ProvisioningConfig1 -UniversalManager true ` - -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` + -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` -PlanInitializerScript null ` -NoProvisioningRequests true ` -ProvisioningRequestExpiration 7 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig1PlanInitializerScript.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig1PlanInitializerScript.md index 0354ed064dd9..f0d5aa847006 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig1PlanInitializerScript.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig1PlanInitializerScript.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ProvisioningConfig1PlanInitializerScript = Initialize-PSSailpoint.V2024ProvisioningConfig1PlanInitializerScript -Source <?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source> +$ProvisioningConfig1PlanInitializerScript = Initialize-PSSailpoint.V2024ProvisioningConfig1PlanInitializerScript -Source \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfigPlanInitializerScript.md index f5099f564b26..5457e19b370d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfigPlanInitializerScript.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfigPlanInitializerScript.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ProvisioningConfigPlanInitializerScript = Initialize-PSSailpoint.V2024ProvisioningConfigPlanInitializerScript -Source <?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source> +$ProvisioningConfigPlanInitializerScript = Initialize-PSSailpoint.V2024ProvisioningConfigPlanInitializerScript -Source \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RandomAlphaNumeric.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RandomAlphaNumeric.md index 6fde6e99611d..3b5db252acae 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RandomAlphaNumeric.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RandomAlphaNumeric.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $RandomAlphaNumeric = Initialize-PSSailpoint.V2024RandomAlphaNumeric -Length 10 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RandomNumeric.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RandomNumeric.md index b2878c096eb4..dd8ffcd649e8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RandomNumeric.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RandomNumeric.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $RandomNumeric = Initialize-PSSailpoint.V2024RandomNumeric -Length 10 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RecommendationResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RecommendationResponse.md index d15ec3e73a5c..5e047909d8c3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RecommendationResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RecommendationResponse.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $RecommendationResponse = Initialize-PSSailpoint.V2024RecommendationResponse -Request null ` -Recommendation true ` -Interpretations [75% of identities with the same department have this access. This information had a high impact on the overall score., 67% of identities with the same peer group have this access. This information had a low impact on the overall score., 42% of identities with the same location have this access. This information had a low impact on the overall score.] ` - -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] ` + -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] ` -RecommenderCalculations null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Reference.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Reference.md index dc4450fcb3ed..76337032a23c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Reference.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Reference.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $Reference = Initialize-PSSailpoint.V2024Reference -Id Existing Transform ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Replace.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Replace.md index 0e14abcaa7d8..55678c611933 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Replace.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Replace.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $Replace = Initialize-PSSailpoint.V2024Replace -Regex [^a-zA-Z] ` -Replacement ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ReplaceAll.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ReplaceAll.md index e4846ef22e8d..e18142034064 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ReplaceAll.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ReplaceAll.md @@ -24,9 +24,9 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ReplaceAll = Initialize-PSSailpoint.V2024ReplaceAll -Table {-= , "=', ñ=n} ` +$ReplaceAll = Initialize-PSSailpoint.V2024ReplaceAll -Table {-= , "=', ñ=n} ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemStatus.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemStatus.md index cad02b05c0bb..c581840ae709 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemStatus.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemStatus.md @@ -68,7 +68,7 @@ $RequestedItemStatus = Initialize-PSSailpoint.V2024RequestedItemStatus -Name Ac -RemoveDate 2019-10-23T00:00Z ` -Cancelable true ` -AccessRequestId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` - -ClientMetadata {key1=value1, key2=value2} + -ClientMetadata {key1=value1, key2=value2} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ResourceObject.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ResourceObject.md index 351613a17f7b..325afbf1ebc6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ResourceObject.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ResourceObject.md @@ -35,7 +35,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ResourceObject = Initialize-PSSailpoint.V2024ResourceObject -Instance null ` - -Identity CN=Aaron Carr,OU=test1,DC=test2,DC=test ` + -Identity CN=Aaron Carr,OU=test1,DC=test2,DC=test ` -Uuid {abf7bd9b-68b4-4d21-9b70-870c58ebf844} ` -PreviousIdentity null ` -Name Aaron Carr ` @@ -45,7 +45,7 @@ $ResourceObject = Initialize-PSSailpoint.V2024ResourceObject -Instance null ` -Delete false ` -Remove false ` -Missing [missFieldOne, missFieldTwo] ` - -Attributes {telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr} ` + -Attributes {telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr} ` -FinalUpdate false ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ReviewableEntitlement.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ReviewableEntitlement.md index 12399719aeb9..3dbb38126a51 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ReviewableEntitlement.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ReviewableEntitlement.md @@ -40,12 +40,12 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ReviewableEntitlement = Initialize-PSSailpoint.V2024ReviewableEntitlement -Id 2c918085718230600171993742c63558 ` - -Name CN=entitlement.bbb7c650 ` + -Name CN=entitlement.bbb7c650 ` -Description Gives read/write access to the company database ` -Privileged false ` -Owner null ` -AttributeName memberOf ` - -AttributeValue CN=entitlement.bbb7c650 ` + -AttributeValue CN=entitlement.bbb7c650 ` -SourceSchemaObjectType groups ` -SourceName ODS-AD-Source ` -SourceType Active Directory - Direct ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ReviewableEntitlementAccount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ReviewableEntitlementAccount.md index d6f3d950c84c..1f251e326a81 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ReviewableEntitlementAccount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ReviewableEntitlementAccount.md @@ -33,7 +33,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ReviewableEntitlementAccount = Initialize-PSSailpoint.V2024ReviewableEntitlementAccount -NativeIdentity CN=Alison Ferguso ` +$ReviewableEntitlementAccount = Initialize-PSSailpoint.V2024ReviewableEntitlementAccount -NativeIdentity CN=Alison Ferguso ` -Disabled false ` -Locked false ` -Type null ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RightPad.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RightPad.md index f9381474499a..5424219550a7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RightPad.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RightPad.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $RightPad = Initialize-PSSailpoint.V2024RightPad -Length 4 ` -Padding 0 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Role.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Role.md index e7be398f83d0..a5a5bb115697 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Role.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Role.md @@ -48,7 +48,7 @@ $Role = Initialize-PSSailpoint.V2024Role -Id 2c918086749d78830174a1a40e121518 ` -AccessProfiles null ` -Entitlements null ` -Membership null ` - -LegacyMembershipInfo {type=IDENTITY_LIST} ` + -LegacyMembershipInfo {type=IDENTITY_LIST} ` -Enabled true ` -Requestable true ` -AccessRequestConfig null ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleAssignmentDto.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleAssignmentDto.md index e708a09c52ea..10d142398e60 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleAssignmentDto.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleAssignmentDto.md @@ -32,10 +32,10 @@ Name | Type | Description | Notes ```powershell $RoleAssignmentDto = Initialize-PSSailpoint.V2024RoleAssignmentDto -Id 1cbb0705b38c4226b1334eadd8874086 ` -Role null ` - -Comments I'm a new Engineer and need this role to do my work ` + -Comments I'm a new Engineer and need this role to do my work ` -AssignmentSource UI ` -Assigner null ` - -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` + -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` -AssignmentContext null ` -AccountTargets null ` -RemoveDate Wed Feb 14 10:58:42 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleDocumentAllOfEntitlements.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleDocumentAllOfEntitlements.md index 26553603ffc2..6b2508a369dd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleDocumentAllOfEntitlements.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleDocumentAllOfEntitlements.md @@ -34,11 +34,11 @@ Name | Type | Description | Notes $RoleDocumentAllOfEntitlements = Initialize-PSSailpoint.V2024RoleDocumentAllOfEntitlements -HasPermissions false ` -Description Cloud engineering ` -Attribute memberOf ` - -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` -Schema group ` -Privileged false ` -Id 2c918084575812550157589064f33b89 ` - -Name CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Name CN=Cloud Engineering,DC=sailpoint,DC=COM ` -SourceSchemaObjectType group ` -Hash c6fab95235584cca98a454a2f51e5683bc77d6a0 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleDocumentAllOfEntitlements1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleDocumentAllOfEntitlements1.md index fd0610afd3af..2c2f53a83387 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleDocumentAllOfEntitlements1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleDocumentAllOfEntitlements1.md @@ -34,11 +34,11 @@ Name | Type | Description | Notes $RoleDocumentAllOfEntitlements1 = Initialize-PSSailpoint.V2024RoleDocumentAllOfEntitlements1 -HasPermissions false ` -Description Cloud engineering ` -Attribute memberOf ` - -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` -Schema group ` -Privileged false ` -Id 2c918084575812550157589064f33b89 ` - -Name CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Name CN=Cloud Engineering,DC=sailpoint,DC=COM ` -SourceSchemaObjectType group ` -Hash c6fab95235584cca98a454a2f51e5683bc77d6a0 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleListFilterDTO.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleListFilterDTO.md index 22a01f5ddd79..4b1062d54cbd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleListFilterDTO.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleListFilterDTO.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $RoleListFilterDTO = Initialize-PSSailpoint.V2024RoleListFilterDTO -Filters dimensional eq false ` - -AmmKeyValues [{attribute=iscFederalClassifications, values=[secret]}] + -AmmKeyValues [{attribute=iscFederalClassifications, values=[secret]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequest.md index a51e5c6b2617..4dea9c43f084 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByFilterRequest.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $RoleMetadataBulkUpdateByFilterRequest = Initialize-PSSailpoint.V2024RoleMetadataBulkUpdateByFilterRequest -Filters requestable eq false ` -Operation REPLACE ` -ReplaceScope ALL ` - -Values [{attribute=iscFederalClassifications, values=[topSecret]}] + -Values [{attribute=iscFederalClassifications, values=[topSecret]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequest.md index 65c035912eff..212f63326fce 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByIdRequest.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $RoleMetadataBulkUpdateByIdRequest = Initialize-PSSailpoint.V2024RoleMetadataBulkUpdateByIdRequest -Roles [b1db89554cfa431cb8b9921ea38d9367] ` -Operation REPLACE ` -ReplaceScope ALL ` - -Values [{attribute=iscFederalClassifications, values=[topSecret]}] + -Values [{attribute=iscFederalClassifications, values=[topSecret]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequest.md index 49d24eb858af..bac207318773 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMetadataBulkUpdateByQueryRequest.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$RoleMetadataBulkUpdateByQueryRequest = Initialize-PSSailpoint.V2024RoleMetadataBulkUpdateByQueryRequest -Query {query"={indices=[roles], queryType=TEXT, textQuery={terms=[test123], fields=[id], matchAny=false, contains=true}, includeNested=false}} ` +$RoleMetadataBulkUpdateByQueryRequest = Initialize-PSSailpoint.V2024RoleMetadataBulkUpdateByQueryRequest -Query {query"={indices=[roles], queryType=TEXT, textQuery={terms=[test123], fields=[id], matchAny=false, contains=true}, includeNested=false}} ` -Operation REPLACE ` -ReplaceScope ALL ` -Values null diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningIdentityDistribution.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningIdentityDistribution.md index 31c7a3cec1b2..602874db864b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningIdentityDistribution.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningIdentityDistribution.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $RoleMiningIdentityDistribution = Initialize-PSSailpoint.V2024RoleMiningIdentityDistribution -AttributeName department ` - -Distribution [{attributeValue=NM Tier 3, count=6}] + -Distribution [{attributeValue=NM Tier 3, count=6}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningPotentialRoleApplication.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningPotentialRoleApplication.md index 5e6c7870a411..c2aad3ea92a2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningPotentialRoleApplication.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningPotentialRoleApplication.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$RoleMiningPotentialRoleApplication = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleApplication -Id {id=2c9180877212632a017228d5a796292b} ` - -Name {name=Slack} +$RoleMiningPotentialRoleApplication = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleApplication -Id {id=2c9180877212632a017228d5a796292b} ` + -Name {name=Slack} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningPotentialRoleEntitlements.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningPotentialRoleEntitlements.md index 7c6487556841..fbdd0622e381 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningPotentialRoleEntitlements.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningPotentialRoleEntitlements.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$RoleMiningPotentialRoleEntitlements = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleEntitlements -Id {id=2c9180877212632a017228d5a796292c} ` - -Name {name=LauncherTest2} +$RoleMiningPotentialRoleEntitlements = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleEntitlements -Id {id=2c9180877212632a017228d5a796292c} ` + -Name {name=LauncherTest2} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningSessionScope.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningSessionScope.md index 029bcb2ef0fb..8a0902b2665c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningSessionScope.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RoleMiningSessionScope.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $RoleMiningSessionScope = Initialize-PSSailpoint.V2024RoleMiningSessionScope -IdentityIds [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42] ` -Criteria source.name:DataScienceDataset ` - -AttributeFilterCriteria {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}} + -AttributeFilterCriteria {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md index ea2ff0b35b41..5fa8cd759e0d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearch.md @@ -41,10 +41,10 @@ $SavedSearch = Initialize-PSSailpoint.V2024SavedSearch -Name Disabled accounts -Created 2018-06-25T20:22:28.104Z ` -Modified 2018-06-25T20:22:28.104Z ` -Indices [identities] ` - -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` -Query @accounts(disabled:true) ` -Fields [disabled] ` - -OrderBy {identity=[lastName, firstName], role=[name]} ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` -Sort [displayName] ` -Filters null ` -Id 0de46054-fe90-434a-b84e-c6b3359d0c64 ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchComplete.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchComplete.md index bddbaf65872f..0fcb196f8177 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchComplete.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchComplete.md @@ -34,7 +34,7 @@ $SavedSearchComplete = Initialize-PSSailpoint.V2024SavedSearchComplete -FileNam -Query modified:[now-7y/d TO now] ` -SearchName Modified Activity ` -SearchResults null ` - -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc + -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md index 9905e0516e91..ef40e2a1055e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SavedSearchDetail.md @@ -33,10 +33,10 @@ Name | Type | Description | Notes $SavedSearchDetail = Initialize-PSSailpoint.V2024SavedSearchDetail -Created 2018-06-25T20:22:28.104Z ` -Modified 2018-06-25T20:22:28.104Z ` -Indices [identities] ` - -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` -Query @accounts(disabled:true) ` -Fields [disabled] ` - -OrderBy {identity=[lastName, firstName], role=[name]} ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` -Sort [displayName] ` -Filters null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Days.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Days.md index f5fbe529fe70..260150cea091 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Days.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Days.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Schedule2Days = Initialize-PSSailpoint.V2024Schedule2Days -ApplicationId 2c91808874ff91550175097daaec161c" ` +$Schedule2Days = Initialize-PSSailpoint.V2024Schedule2Days -ApplicationId 2c91808874ff91550175097daaec161c" ` -AccountMatchConfig null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Hours.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Hours.md index 4b949f0869cd..9038e493a755 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Hours.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Hours.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Schedule2Hours = Initialize-PSSailpoint.V2024Schedule2Hours -ApplicationId 2c91808874ff91550175097daaec161c" ` +$Schedule2Hours = Initialize-PSSailpoint.V2024Schedule2Hours -ApplicationId 2c91808874ff91550175097daaec161c" ` -AccountMatchConfig null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Months.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Months.md index c7bc7a83fbd8..5357adb60b25 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Months.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Schedule2Months.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Schedule2Months = Initialize-PSSailpoint.V2024Schedule2Months -ApplicationId 2c91808874ff91550175097daaec161c" ` +$Schedule2Months = Initialize-PSSailpoint.V2024Schedule2Months -ApplicationId 2c91808874ff91550175097daaec161c" ` -AccountMatchConfig null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Schema.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Schema.md index 362197740fa0..af33f0cba033 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Schema.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Schema.md @@ -41,8 +41,8 @@ $Schema = Initialize-PSSailpoint.V2024Schema -Id 2c9180835d191a86015d28455b4a23 -HierarchyAttribute memberOf ` -IncludePermissions false ` -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` - -Configuration {groupMemberAttribute=member} ` - -Attributes [{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}] ` + -Configuration {groupMemberAttribute=member} ` + -Attributes [{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}] ` -Created 2019-12-24T22:32:58.104Z ` -Modified 2019-12-31T20:22:28.104Z ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Scope.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Scope.md index d37cf5107905..ae397e26a465 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Scope.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Scope.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $Scope = Initialize-PSSailpoint.V2024Scope -Scope null ` -Visibility null ` -ScopeFilter null ` - -ScopeSelection [{type=IDENTITY, id=29cb6c061da843ea8be4b3125f248f2a}, {type=IDENTITY, id=f7b1b8a35fed4fd4ad2982014e137e19}] + -ScopeSelection [{type=IDENTITY, id=29cb6c061da843ea8be4b3125f248f2a}, {type=IDENTITY, id=f7b1b8a35fed4fd4ad2982014e137e19}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md index 17504dd24391..de3349bb01d6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Search.md @@ -41,7 +41,7 @@ $Search = Initialize-PSSailpoint.V2024Search -Indices [identities] ` -QueryType null ` -QueryVersion null ` -Query null ` - -QueryDsl {match={name=john.doe}} ` + -QueryDsl {match={name=john.doe}} ` -TextQuery null ` -TypeAheadQuery null ` -IncludeNested true ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchAttributeConfig.md index 18c9ec5c769e..4049b39913af 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchAttributeConfig.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $SearchAttributeConfig = Initialize-PSSailpoint.V2024SearchAttributeConfig -Name newMailAttribute ` -DisplayName New Mail Attribute ` - -ApplicationAttributes {2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} + -ApplicationAttributes {2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Selector.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Selector.md index 87112ce48d36..ec932f9c1d7d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Selector.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Selector.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Selector = Initialize-PSSailpoint.V2024Selector -ApplicationId 2c91808874ff91550175097daaec161c" ` +$Selector = Initialize-PSSailpoint.V2024Selector -ApplicationId 2c91808874ff91550175097daaec161c" ` -AccountMatchConfig null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SelectorAccountMatchConfigMatchExpression.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SelectorAccountMatchConfigMatchExpression.md index a633a9d28913..bcf48f29344b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SelectorAccountMatchConfigMatchExpression.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SelectorAccountMatchConfigMatchExpression.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SelectorAccountMatchConfigMatchExpression = Initialize-PSSailpoint.V2024SelectorAccountMatchConfigMatchExpression -MatchTerms [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}] ` +$SelectorAccountMatchConfigMatchExpression = Initialize-PSSailpoint.V2024SelectorAccountMatchConfigMatchExpression -MatchTerms [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}] ` -And true ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationDto.md index b54188f165dd..f28f4a6d6522 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationDto.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationDto.md @@ -45,7 +45,7 @@ $ServiceDeskIntegrationDto = Initialize-PSSailpoint.V2024ServiceDeskIntegrationD -Cluster xyzzy999 ` -ManagedSources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` -ProvisioningConfig null ` - -Attributes {property=value, key=value} ` + -Attributes {property=value, key=value} ` -BeforeProvisioningRule null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationDto1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationDto1.md index 84f104cbaed1..89c61fd084a4 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationDto1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationDto1.md @@ -39,7 +39,7 @@ $ServiceDeskIntegrationDto1 = Initialize-PSSailpoint.V2024ServiceDeskIntegration -Cluster xyzzy999 ` -ManagedSources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` -ProvisioningConfig null ` - -Attributes {property=value, key=value} ` + -Attributes {property=value, key=value} ` -BeforeProvisioningRule null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationTemplateDto.md index d2b10769e429..54e0240d9808 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationTemplateDto.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationTemplateDto.md @@ -33,7 +33,7 @@ $ServiceDeskIntegrationTemplateDto = Initialize-PSSailpoint.V2024ServiceDeskInte -Created 2015-05-28T14:07:17Z ` -Modified 2015-05-28T14:07:17Z ` -Type Web Service SDIM ` - -Attributes {property=value, key=value} ` + -Attributes {property=value, key=value} ` -ProvisioningConfig null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SimIntegrationDetails.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SimIntegrationDetails.md index fe0462818b59..bd47bfb505d7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SimIntegrationDetails.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SimIntegrationDetails.md @@ -39,11 +39,11 @@ $SimIntegrationDetails = Initialize-PSSailpoint.V2024SimIntegrationDetails -Id -Modified 2023-01-03T21:16:22.432Z ` -Description Integration description ` -Type ServiceNow Service Desk ` - -Attributes {"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"} ` + -Attributes {"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"} ` -Sources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` -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} ` + -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} ` -BeforeProvisioningRule null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SodPolicy.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SodPolicy.md index c3a5417f5fe6..a952d96969a6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SodPolicy.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SodPolicy.md @@ -47,7 +47,7 @@ $SodPolicy = Initialize-PSSailpoint.V2024SodPolicy -Id 0f11f2a4-7c94-4bf3-a2bd- -OwnerRef null ` -ExternalPolicyReference XYZ policy ` -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 ` + -CompensatingControls Have a manager review the transaction decisions for their "out of compliance" employee ` -CorrectionAdvice Based on the role of the employee, managers should remove access that is not required for their job function. ` -State ENFORCED ` -Tags [TAG1, TAG2] ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationCheckResult.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationCheckResult.md index a9c94b88b99b..7caf29846a0f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationCheckResult.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationCheckResult.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $SodViolationCheckResult = Initialize-PSSailpoint.V2024SodViolationCheckResult -Message null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -ViolationContexts null ` -ViolatedPolicies null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationCheckResult1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationCheckResult1.md index 85e499e491a7..02e22c212cec 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationCheckResult1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationCheckResult1.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $SodViolationCheckResult1 = Initialize-PSSailpoint.V2024SodViolationCheckResult1 -Message null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -ViolationContexts null ` -ViolatedPolicies null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Source.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Source.md index 27b141b509bc..b06b861bd8f3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Source.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Source.md @@ -62,13 +62,13 @@ $Source = Initialize-PSSailpoint.V2024Source -Id 2c91808568c529c60168cca6f90c13 -ManagerCorrelationMapping null ` -ManagerCorrelationRule null ` -BeforeProvisioningRule null ` - -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` - -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` + -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` + -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` -Type OpenLDAP - Direct ` -Connector active-directory ` -ConnectorClass sailpoint.connector.LDAPConnector ` - -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` + -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` -DeleteThreshold 10 ` -Authoritative false ` -ManagementWorkgroup null ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Source1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Source1.md index 320255ad723d..5e62b852737a 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Source1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Source1.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Source1 = Initialize-PSSailpoint.V2024Source1 -Type rule ` - -Properties {ruleType=IdentityAttribute, ruleName=Cloud Promote Identity Attribute} + -Properties {ruleType=IdentityAttribute, ruleName=Cloud Promote Identity Attribute} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountCreated.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountCreated.md index c394b1a316b9..28182c494391 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountCreated.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountCreated.md @@ -36,7 +36,7 @@ $SourceAccountCreated = Initialize-PSSailpoint.V2024SourceAccountCreated -Uuid -SourceName Active Directory ` -IdentityId ee769173319b41d19ccec6c235423237b ` -IdentityName john.doe ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountDeleted.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountDeleted.md index 9cc9ff06a9b5..7f5c47ed203b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountDeleted.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountDeleted.md @@ -36,7 +36,7 @@ $SourceAccountDeleted = Initialize-PSSailpoint.V2024SourceAccountDeleted -Uuid -SourceName Active Directory ` -IdentityId ee769173319b41d19ccec6c235423237b ` -IdentityName john.doe ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountUpdated.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountUpdated.md index b2eba70034a4..d4d848af83c2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountUpdated.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountUpdated.md @@ -36,7 +36,7 @@ $SourceAccountUpdated = Initialize-PSSailpoint.V2024SourceAccountUpdated -Uuid -SourceName Active Directory ` -IdentityId ee769173319b41d19ccec6c235423237b ` -IdentityName john.doe ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAppAccountSource.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAppAccountSource.md index 832959f63afd..0888d0cc3d9c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAppAccountSource.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAppAccountSource.md @@ -30,7 +30,7 @@ $SourceAppAccountSource = Initialize-PSSailpoint.V2024SourceAppAccountSource -I -Type SOURCE ` -Name ODS-AD-Source ` -UseForPasswordManagement false ` - -PasswordPolicies [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}] + -PasswordPolicies [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAppBulkUpdateRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAppBulkUpdateRequest.md index 93bd35a41ba3..a259881e37ac 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAppBulkUpdateRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAppBulkUpdateRequest.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $SourceAppBulkUpdateRequest = Initialize-PSSailpoint.V2024SourceAppBulkUpdateRequest -AppIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] ` - -JsonPatch [{op=replace, path=/enabled, value=false}, {op=replace, path=/matchAllAccounts, value=false}] + -JsonPatch [{op=replace, path=/enabled, value=false}, {op=replace, path=/matchAllAccounts, value=false}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceCode.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceCode.md index 260632e34c07..37e600cb0c30 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceCode.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceCode.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $SourceCode = Initialize-PSSailpoint.V2024SourceCode -Version 1.0 ` - -Script return "Mr. " + firstName; + -Script return "Mr. " + firstName; ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceSyncPayload.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceSyncPayload.md index ee03f90113f2..538376975960 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceSyncPayload.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceSyncPayload.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $SourceSyncPayload = Initialize-PSSailpoint.V2024SourceSyncPayload -Type SYNCHRONIZE_SOURCE_ATTRIBUTES ` - -DataJson {"sourceId":"2c918083746f642c01746f990884012a"} + -DataJson {"sourceId":"2c918083746f642c01746f990884012a"} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md index 3d6b4c94acc1..235e4ab2c339 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/SpConfigImportResults.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigImportResults.md index 52ae44706a93..7f1145bb8bf2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigImportResults.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigImportResults.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SpConfigImportResults = Initialize-PSSailpoint.V2024SpConfigImportResults -Results {results={TRIGGER_SUBSCRIPTION={infos=[{key=IMPORT_PREVIEW, text=Object to be imported: [c953134c-2224-42f2-a84e-fa5cbb395904, Test 2], detail=null}, {key=IMPORT_PREVIEW, text=Object to be imported: [be9e116d-08e1-49fc-ab7f-fa585e96c9e4, Test 1], detail=null}], warnings=[], errors=[], importedObjects=[]}}} ` +$SpConfigImportResults = Initialize-PSSailpoint.V2024SpConfigImportResults -Results {results={TRIGGER_SUBSCRIPTION={infos=[{key=IMPORT_PREVIEW, text=Object to be imported: [c953134c-2224-42f2-a84e-fa5cbb395904, Test 2], detail=null}, {key=IMPORT_PREVIEW, text=Object to be imported: [be9e116d-08e1-49fc-ab7f-fa585e96c9e4, Test 1], detail=null}], warnings=[], errors=[], importedObjects=[]}}} ` -ExportJobId be9e116d-08e1-49fc-ab7f-fa585e96c9e4 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigMessage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigMessage.md index 96dbe43dc4ee..74cec21a295b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigMessage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigMessage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $SpConfigMessage = Initialize-PSSailpoint.V2024SpConfigMessage -Key UNKNOWN_REFERENCE_RESOLVER ` -Text Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity] ` - -Details {details=message details} + -Details {details=message details} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigMessage1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigMessage1.md index ec9b90fb5d41..3f7f757a942b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigMessage1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigMessage1.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $SpConfigMessage1 = Initialize-PSSailpoint.V2024SpConfigMessage1 -Key UNKNOWN_REFERENCE_RESOLVER ` -Text Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity] ` - -Details {details=message details} + -Details {details=message details} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md index 207e294e5695..f715ae4ac2c3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigObject.md @@ -19,7 +19,6 @@ Name | Type | Description | Notes **ObjectType** | **String** | The object type this configuration is for. | [optional] **ReferenceExtractors** | **[]String** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] **SignatureRequired** | **Boolean** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false] -**AlwaysResolveById** | **Boolean** | Whether this object type has to be resolved always by ID | [optional] [default to $false] **LegacyObject** | **Boolean** | Whether this is a legacy object | [optional] [default to $false] **OnePerTenant** | **Boolean** | Whether there is only one object of this type | [optional] [default to $false] **Exportable** | **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false] @@ -32,7 +31,6 @@ Name | Type | Description | Notes $SpConfigObject = Initialize-PSSailpoint.V2024SpConfigObject -ObjectType TRIGGER_SUBSCRIPTION ` -ReferenceExtractors [$.owner] ` -SignatureRequired false ` - -AlwaysResolveById true ` -LegacyObject false ` -OnePerTenant false ` -Exportable true ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md index 67141faf23f9..f1baab92676d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRule.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'V2024SpConfigRule'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Path** | **String** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] -**Value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional] -**Modes** | **[]String** | Draft modes to which this rule will apply | [optional] +**Value** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value to be assigned at the jsonPath location within the object | [optional] +**Mode** | **[]String** | Draft modes to which this rule will apply | [optional] ## Examples @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $SpConfigRule = Initialize-PSSailpoint.V2024SpConfigRule -Path $.enabled ` -Value null ` - -Modes [RESTORE, PROMOTE] + -Mode [RESTORE, PROMOTE] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRuleValue.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRuleValue.md deleted file mode 100644 index a975f10153d5..000000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigRuleValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: v2024-sp-config-rule-value -title: SpConfigRuleValue -pagination_label: SpConfigRuleValue -sidebar_label: SpConfigRuleValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRuleValue', 'V2024SpConfigRuleValue'] -slug: /tools/sdk/powershell/v2024/models/sp-config-rule-value -tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'V2024SpConfigRuleValue'] ---- - - -# SpConfigRuleValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$SpConfigRuleValue = Initialize-PSSailpoint.V2024SpConfigRuleValue -``` - -- Convert the resource to JSON -```powershell -$SpConfigRuleValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Split.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Split.md index 6d21cb2fddbd..1728bd0e3b00 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Split.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Split.md @@ -30,7 +30,7 @@ $Split = Initialize-PSSailpoint.V2024Split -Delimiter , ` -Index 5 ` -Throws true ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/StartInvocationInput.md b/docs/tools/sdk/powershell/Reference/V2024/Models/StartInvocationInput.md index 6abc96656589..16d144d15012 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/StartInvocationInput.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/StartInvocationInput.md @@ -25,8 +25,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $StartInvocationInput = Initialize-PSSailpoint.V2024StartInvocationInput -TriggerId idn:access-requested ` - -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` - -ContentJson {workflowId=1234} + -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -ContentJson {workflowId=1234} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/StatusResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/StatusResponse.md index 3ce8bcbf37ec..2a960edb8111 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/StatusResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/StatusResponse.md @@ -30,7 +30,7 @@ $StatusResponse = Initialize-PSSailpoint.V2024StatusResponse -Id 2c91808568c529 -Name ODS-AD-Test [source-999999] ` -Status SUCCESS ` -ElapsedMillis 1000 ` - -Details {useTLSForIQService=false, IQService={TLS Port=0, .NET CLR Version=4.0.30319.42000, SecondaryServiceStatus=Running, Port=5050, Host=AUTOMATION-AD, Name=IQService, IQServiceStatus=Running, SecondaryService=IQService-Instance1-Secondary, Version=IQService Sep-2020, secondaryPort=5051, OS Architecture=AMD64, Operating System=Microsoft Windows Server 2012 R2 Standard, highestDotNetVersion=4.8 or later, Build Time=09/22/2020 06:34 AM -0500}, IQServiceClientAuthEnabled=false, requestProcessedOn=1/19/2021 1:47:14 PM} + -Details {useTLSForIQService=false, IQService={TLS Port=0, .NET CLR Version=4.0.30319.42000, SecondaryServiceStatus=Running, Port=5050, Host=AUTOMATION-AD, Name=IQService, IQServiceStatus=Running, SecondaryService=IQService-Instance1-Secondary, Version=IQService Sep-2020, secondaryPort=5051, OS Architecture=AMD64, Operating System=Microsoft Windows Server 2012 R2 Standard, highestDotNetVersion=4.8 or later, Build Time=09/22/2020 06:34 AM -0500}, IQServiceClientAuthEnabled=false, requestProcessedOn=1/19/2021 1:47:14 PM} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Subscription.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Subscription.md index e163306d26d1..c3e9073eeda1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Subscription.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Subscription.md @@ -42,7 +42,7 @@ $Subscription = Initialize-PSSailpoint.V2024Subscription -Id 0f11f2a4-7c94-4bf3 -HttpConfig null ` -EventBridgeConfig null ` -Enabled true ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SubscriptionPostRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SubscriptionPostRequest.md index ab47309c5027..07241dd4f703 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SubscriptionPostRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SubscriptionPostRequest.md @@ -38,7 +38,7 @@ $SubscriptionPostRequest = Initialize-PSSailpoint.V2024SubscriptionPostRequest -HttpConfig null ` -EventBridgeConfig null ` -Enabled true ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SubscriptionPutRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SubscriptionPutRequest.md index 77b00e70238d..178bb67c730f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SubscriptionPutRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SubscriptionPutRequest.md @@ -36,7 +36,7 @@ $SubscriptionPutRequest = Initialize-PSSailpoint.V2024SubscriptionPutRequest -N -HttpConfig null ` -EventBridgeConfig null ` -Enabled true ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Substring.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Substring.md index 7ba2d1857332..695d00e0f1b9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Substring.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Substring.md @@ -32,7 +32,7 @@ $Substring = Initialize-PSSailpoint.V2024Substring -VarBegin 1 ` -VarEnd 6 ` -EndOffset 1 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TaskResultDetails.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TaskResultDetails.md index 406500b21c5a..45f1838c9e2e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TaskResultDetails.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TaskResultDetails.md @@ -47,7 +47,7 @@ $TaskResultDetails = Initialize-PSSailpoint.V2024TaskResultDetails -Type MENTOS -CompletionStatus Success ` -Messages [] ` -Returns [] ` - -Attributes {org=an-org} ` + -Attributes {org=an-org} ` -Progress Initializing... ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TaskStatus.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TaskStatus.md index 8fa134f64bd7..bf3d01c865a2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TaskStatus.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TaskStatus.md @@ -53,7 +53,7 @@ $TaskStatus = Initialize-PSSailpoint.V2024TaskStatus -Id id12345 ` -CompletionStatus SUCCESS ` -Messages null ` -Returns null ` - -Attributes {identityCount=0} ` + -Attributes {identityCount=0} ` -Progress Started ` -PercentComplete 100 ` -TaskDefinitionSummary null diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TaskStatusMessage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TaskStatusMessage.md index 44c6209a1ec5..601abb554a68 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TaskStatusMessage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TaskStatusMessage.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $TaskStatusMessage = Initialize-PSSailpoint.V2024TaskStatusMessage -Type INFO ` -LocalizedText null ` -Key akey ` - -Parameters [{name=value}] + -Parameters [{name=value}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TemplateDto.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TemplateDto.md index aedaacaa99fd..0b04eaa00aa3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TemplateDto.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TemplateDto.md @@ -47,7 +47,7 @@ $TemplateDto = Initialize-PSSailpoint.V2024TemplateDto -Key cloud_manual_work_i -Footer null ` -VarFrom $__global.emailFromAddress ` -ReplyTo $__global.emailFromAddress ` - -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` + -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` -Id c17bea3a-574d-453c-9e04-4365fbf5af0b ` -Created 2020-01-01T00:00Z ` -Modified 2020-01-01T00:00Z ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TemplateDtoDefault.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TemplateDtoDefault.md index fb33017a4d32..df22cbeb25fd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TemplateDtoDefault.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TemplateDtoDefault.md @@ -44,7 +44,7 @@ $TemplateDtoDefault = Initialize-PSSailpoint.V2024TemplateDtoDefault -Key cloud -Footer null ` -VarFrom $__global.emailFromAddress ` -ReplyTo $__global.emailFromAddress ` - -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` + -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` -SlackTemplate null ` -TeamsTemplate null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TestExternalExecuteWorkflow200Response.md index 906c13261816..16d6624bad56 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TestExternalExecuteWorkflow200Response.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TestExternalExecuteWorkflow200Response.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$TestExternalExecuteWorkflow200Response = Initialize-PSSailpoint.V2024TestExternalExecuteWorkflow200Response -Payload {test=hello world} +$TestExternalExecuteWorkflow200Response = Initialize-PSSailpoint.V2024TestExternalExecuteWorkflow200Response -Payload {test=hello world} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TestExternalExecuteWorkflowRequest.md index cffa57e475cc..d88e36bf4bd7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TestExternalExecuteWorkflowRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TestExternalExecuteWorkflowRequest.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$TestExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V2024TestExternalExecuteWorkflowRequest -VarInput {test=hello world} +$TestExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V2024TestExternalExecuteWorkflowRequest -VarInput {test=hello world} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TestInvocation.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TestInvocation.md index 596129043397..4760cbf0c533 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TestInvocation.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TestInvocation.md @@ -26,8 +26,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $TestInvocation = Initialize-PSSailpoint.V2024TestInvocation -TriggerId idn:access-request-post-approval ` - -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` - -ContentJson {workflowId=1234} ` + -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -ContentJson {workflowId=1234} ` -SubscriptionIds [0f11f2a4-7c94-4bf3-a2bd-742580fe3bde] ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TransformAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TransformAttributes.md index ce493637fa55..8f31d245cd90 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TransformAttributes.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TransformAttributes.md @@ -67,10 +67,10 @@ $TransformAttributes = Initialize-PSSailpoint.V2024TransformAttributes -SourceN -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` -Values string$variable ` -Expression now+1w ` -PositiveCondition true ` @@ -92,7 +92,7 @@ $TransformAttributes = Initialize-PSSailpoint.V2024TransformAttributes -SourceN -Substring admin_ ` -Format alpha2 ` -Padding 0 ` - -Table {-= , "=', ñ=n} ` + -Table {-= , "=', ñ=n} ` -Id Existing Transform ` -Regex [^a-zA-Z] ` -Replacement ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md index 2f16927eb9de..d58c716ee0f8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'V2024Transform Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | Transform definition type. | [optional] +**Type** | **String** | The type of the transform definition. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $TransformDefinition = Initialize-PSSailpoint.V2024TransformDefinition -Type accountAttribute ` - -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} + -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Trigger.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Trigger.md index 14fa44b3d43c..1419dc66219c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Trigger.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Trigger.md @@ -33,9 +33,9 @@ $Trigger = Initialize-PSSailpoint.V2024Trigger -Id idn:access-request-dynamic-a -Name Access Request Dynamic Approver ` -Type null ` -Description Trigger for getting a dynamic approver. ` - -InputSchema {"definitions":{"record:AccessRequestDynamicApproverInput":{"type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"additionalProperties":true,"properties":{"accessRequestId":{"type":"string"},"requestedFor":{"$ref":"#/definitions/record:requestedForIdentityRef"},"requestedItems":{"type":"array","items":{"$ref":"#/definitions/record:requestedObjectRef"}},"requestedBy":{"$ref":"#/definitions/record:requestedByIdentityRef"}}},"record:requestedForIdentityRef":{"type":"object","required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"record:requestedObjectRef":{"type":"object","optional":["description","comment"],"required":["id","name","type","operation"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"oneOf":[{"type":"null"},{"type":"string"}]},"type":{"type":"string"},"operation":{"type":"string"},"comment":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"record:requestedByIdentityRef":{"type":"object","required":["type","id","name"],"additionalProperties":true,"properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverInput"} ` + -InputSchema {"definitions":{"record:AccessRequestDynamicApproverInput":{"type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"additionalProperties":true,"properties":{"accessRequestId":{"type":"string"},"requestedFor":{"$ref":"#/definitions/record:requestedForIdentityRef"},"requestedItems":{"type":"array","items":{"$ref":"#/definitions/record:requestedObjectRef"}},"requestedBy":{"$ref":"#/definitions/record:requestedByIdentityRef"}}},"record:requestedForIdentityRef":{"type":"object","required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"record:requestedObjectRef":{"type":"object","optional":["description","comment"],"required":["id","name","type","operation"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"oneOf":[{"type":"null"},{"type":"string"}]},"type":{"type":"string"},"operation":{"type":"string"},"comment":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"record:requestedByIdentityRef":{"type":"object","required":["type","id","name"],"additionalProperties":true,"properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverInput"} ` -ExampleInput null ` - -OutputSchema {"definitions":{"record:AccessRequestDynamicApproverOutput":{"type":["null","object"],"required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverOutput"} ` + -OutputSchema {"definitions":{"record:AccessRequestDynamicApproverOutput":{"type":["null","object"],"required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverOutput"} ` -ExampleOutput null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TriggerExampleInput.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TriggerExampleInput.md index f3f7a1921a16..377b15edde68 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TriggerExampleInput.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TriggerExampleInput.md @@ -85,7 +85,7 @@ $TriggerExampleInput = Initialize-PSSailpoint.V2024TriggerExampleInput -AccessR -Identity null ` -Account null ` -Changes null ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ` + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ` -EntitlementCount 0 ` -Campaign null ` -Certification null ` @@ -101,7 +101,7 @@ $TriggerExampleInput = Initialize-PSSailpoint.V2024TriggerExampleInput -AccessR -Query modified:[now-7y/d TO now] ` -SearchName Modified Activity ` -SearchResults null ` - -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc ` + -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc ` -Uuid b7264868-7201-415f-9118-b581d431c688 ` -Id 2c9180866166b5b0016167c32ef31a66 ` -NativeIdentifier E009 ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Trim.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Trim.md index c8139bc42ab9..88c51d8b7631 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Trim.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Trim.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Trim = Initialize-PSSailpoint.V2024Trim -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Upper.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Upper.md index e5c3d193650b..4e9d0a2c6542 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Upper.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Upper.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Upper = Initialize-PSSailpoint.V2024Upper -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/V3ConnectorDto.md b/docs/tools/sdk/powershell/Reference/V2024/Models/V3ConnectorDto.md index 1bec501d5383..3f47d9cd4758 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/V3ConnectorDto.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/V3ConnectorDto.md @@ -35,7 +35,7 @@ $V3ConnectorDto = Initialize-PSSailpoint.V2024V3ConnectorDto -Name name ` -ClassName sailpoint.connector.OpenConnectorAdapter ` -Features [PROVISIONING, SYNC_PROVISIONING, SEARCH, UNSTRUCTURED_TARGETS] ` -DirectConnect true ` - -ConnectorMetadata {supportedUI=ANGULAR, platform=ccg, shortDesc=connector description} ` + -ConnectorMetadata {supportedUI=ANGULAR, platform=ccg, shortDesc=connector description} ` -Status RELEASED ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ValidateFilterInputDto.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ValidateFilterInputDto.md index 9900939c0857..f6dd65361a81 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ValidateFilterInputDto.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ValidateFilterInputDto.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ValidateFilterInputDto = Initialize-PSSailpoint.V2024ValidateFilterInputDto -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] +$ValidateFilterInputDto = Initialize-PSSailpoint.V2024ValidateFilterInputDto -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkItemForward.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkItemForward.md index 3fb0e959a530..fb816b5ac6f8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkItemForward.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkItemForward.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $WorkItemForward = Initialize-PSSailpoint.V2024WorkItemForward -TargetOwnerId 2c9180835d2e5168015d32f890ca1581 ` - -Comment I'm going on vacation. ` + -Comment I'm going on vacation. ` -SendNotifications true ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkItems.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkItems.md index 0c78e0856f22..a41309043719 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkItems.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkItems.md @@ -45,7 +45,7 @@ $WorkItems = Initialize-PSSailpoint.V2024WorkItems -Id 2c9180835d2e5168015d32f8 -OwnerName Jason Smith ` -Created 2017-07-11T18:45:37.098Z ` -Modified 2018-06-25T20:22:28.104Z ` - -Description Create account on source 'AD' ` + -Description Create account on source 'AD' ` -State null ` -Type null ` -RemediationItems null ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Workflow.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Workflow.md index a4f79dbc3a10..186d7b20078e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Workflow.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Workflow.md @@ -36,7 +36,7 @@ Name | Type | Description | Notes ```powershell $Workflow = Initialize-PSSailpoint.V2024Workflow -Name Send Email ` -Owner null ` - -Description Send an email to the identity who's attributes changed. ` + -Description Send an email to the identity who's attributes changed. ` -Definition null ` -Enabled false ` -Trigger null ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowBody.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowBody.md index a799646ca01d..9be6e0c91d93 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowBody.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowBody.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes ```powershell $WorkflowBody = Initialize-PSSailpoint.V2024WorkflowBody -Name Send Email ` -Owner null ` - -Description Send an email to the identity who's attributes changed. ` + -Description Send an email to the identity who's attributes changed. ` -Definition null ` -Enabled false ` -Trigger null diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowDefinition.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowDefinition.md index 61aa57bfc2e0..7376798321f0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowDefinition.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowDefinition.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $WorkflowDefinition = Initialize-PSSailpoint.V2024WorkflowDefinition -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}} + -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}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md index 534e28991045..c2fdf1dec278 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryAction.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryAction.md index a86d5f66f599..66991229d137 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryAction.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryAction.md @@ -44,7 +44,7 @@ $WorkflowLibraryAction = Initialize-PSSailpoint.V2024WorkflowLibraryAction -Id -VersionNumber null ` -IsSimulationEnabled null ` -IsDynamicSchema false ` - -OutputSchema {definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} + -OutputSchema {definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryOperator.md index 8f3acd4af8b6..ba6ba51ef088 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryOperator.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryOperator.md @@ -38,7 +38,7 @@ $WorkflowLibraryOperator = Initialize-PSSailpoint.V2024WorkflowLibraryOperator -Deprecated null ` -DeprecatedBy null ` -IsSimulationEnabled null ` - -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryTrigger.md index 39661328631e..ccb0cb5afbf0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryTrigger.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowLibraryTrigger.md @@ -41,7 +41,7 @@ $WorkflowLibraryTrigger = Initialize-PSSailpoint.V2024WorkflowLibraryTrigger -I -Name Identity Attributes Changed ` -Description One or more identity attributes changed. ` -IsDynamicSchema false ` - -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ` + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ` -FormFields [] ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowTriggerAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowTriggerAttributes.md index 3396455bb88b..891b20a69f72 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowTriggerAttributes.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowTriggerAttributes.md @@ -34,7 +34,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $WorkflowTriggerAttributes = Initialize-PSSailpoint.V2024WorkflowTriggerAttributes -Id idn:identity-attributes-changed ` - -VarFilter $.changes[?(@.attribute == 'manager')] ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` -Description Run a search and notify the results ` -AttributeToFilter LifecycleState ` -Name search-and-notify ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupDeleteItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupDeleteItem.md index 84f67fb80519..038074f0cbd8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupDeleteItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupDeleteItem.md @@ -27,11 +27,11 @@ Name | Type | Description | Notes $WorkgroupDeleteItem = Initialize-PSSailpoint.V2024WorkgroupDeleteItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` -Status 204 ` -Description -> Governance Group deleted successfully. +> Governance Group deleted successfully. -> Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use. +> Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use. -> Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found. +> Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found. ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupMemberAddItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupMemberAddItem.md index 941d46c8d653..71c8096451bd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupMemberAddItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupMemberAddItem.md @@ -27,9 +27,9 @@ Name | Type | Description | Notes $WorkgroupMemberAddItem = Initialize-PSSailpoint.V2024WorkgroupMemberAddItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` -Status 201 ` -Description -> Identity is added into Governance Group members list. +> Identity is added into Governance Group members list. -> Unable to set Membership of Identity "3244d5f2d04447498520f54c6789ae33" to Governance Group "f80bba83-98c4-4ec2-81c8-373c00e9663b"; the relationship already exists. +> Unable to set Membership of Identity "3244d5f2d04447498520f54c6789ae33" to Governance Group "f80bba83-98c4-4ec2-81c8-373c00e9663b"; the relationship already exists. ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupMemberDeleteItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupMemberDeleteItem.md index f66d76ee6731..1ed1905cdbbf 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupMemberDeleteItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkgroupMemberDeleteItem.md @@ -27,9 +27,9 @@ Name | Type | Description | Notes $WorkgroupMemberDeleteItem = Initialize-PSSailpoint.V2024WorkgroupMemberDeleteItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` -Status 204 ` -Description -> Identity deleted from Governance Group members list. +> Identity deleted from Governance Group members list. -> Referenced Governance Group Member with Identity Id "bc3a744678534eb78a8002ee2085df64" was not found. +> Referenced Governance Group Member with Identity Id "bc3a744678534eb78a8002ee2085df64" was not found. ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md index efd82e759b90..410d3e0523ee 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md @@ -386,8 +386,8 @@ Param Type | Name | Data Type | Required | Description Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. 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 | DetailLevel | **String** | (optional) | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* - 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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* + 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: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** ### Return type [**Account[]**](../models/account) @@ -412,8 +412,8 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $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) $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) -$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) +$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (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, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # Accounts List diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md index d45a1b87eddf..1ef0b0c0c908 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md @@ -27,21 +27,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile -[**Remove-IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile +[**New-IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile +[**Remove-IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile [**Remove-IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles [**Export-IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles [**Get-DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config -[**Get-IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile +[**Get-IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get single Identity Profile [**Import-IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles -[**Get-IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles +[**Get-IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List [**Show-IdentityPreview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview [**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 Identity Profile +[**Update-IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile ## create-identity-profile -Creates an identity profile. +This creates an Identity Profile. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-identity-profile) @@ -56,7 +56,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -201 | Created identity profile. | IdentityProfile +201 | The created Identity Profile | IdentityProfile 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 @@ -119,7 +119,7 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create Identity Profile +# Create an Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -135,15 +135,19 @@ try { [[Back to top]](#) ## delete-identity-profile -Delete an identity profile by ID. +This deletes an Identity Profile based on ID. + 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 ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | IdentityProfileId | **String** | True | The Identity Profile ID. ### Return type [**TaskResultSimplified**](../models/task-result-simplified) @@ -165,9 +169,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. -# Delete Identity Profile +# Delete an Identity Profile try { Remove-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -333,14 +337,14 @@ try { [[Back to top]](#) ## get-identity-profile -Get a single identity profile by ID. +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 ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | IdentityProfileId | **String** | True | The Identity Profile ID. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -348,7 +352,7 @@ Path | IdentityProfileId | **String** | True | Identity profile ID. ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Identity profile object. | IdentityProfile +200 | An Identity Profile object. | IdentityProfile 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 @@ -362,9 +366,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. -# Get Identity Profile +# Get single Identity Profile try { Get-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -487,7 +491,7 @@ try { [[Back to top]](#) ## list-identity-profiles -Get a list of identity profiles, based on the specified query parameters. +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) @@ -497,7 +501,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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* + 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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* 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: **id, name, priority, created, modified, owner.id, owner.name** ### Return type @@ -506,7 +510,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of identity profiles. | IdentityProfile[] +200 | List of identityProfiles. | IdentityProfile[] 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 @@ -522,10 +526,10 @@ Code | Description | Data Type $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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) +$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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (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, priority, created, modified, owner.id, owner.name** (optional) -# List Identity Profiles +# Identity Profiles List try { Get-IdentityProfiles @@ -663,23 +667,25 @@ try { [[Back to top]](#) ## update-identity-profile -Update a specified identity profile with this PATCH request. +This updates the specified Identity Profile. -You cannot update these fields: + +Some fields of the Schema cannot be updated. These fields are listed below: * id +* name * created * modified * identityCount * identityRefreshRequired -* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. +* 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 ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | Identity profile ID. - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Path | IdentityProfileId | **String** | True | The Identity Profile ID + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -687,7 +693,7 @@ Path | IdentityProfileId | **String** | True | Identity profile ID. ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Updated identity profile. | IdentityProfile +200 | The updated Identity Profile. | IdentityProfile 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 @@ -701,15 +707,15 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" -}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update Identity Profile +# Update the Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md index 58c560f9494c..5f9bbcb62eec 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md @@ -252,7 +252,7 @@ try { [[Back to top]](#) ## create-non-employee-source -Create a 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) @@ -1404,20 +1404,22 @@ try { [[Back to top]](#) ## list-non-employee-sources -Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: - 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. - 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. +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 +she may request a list sources 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 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 ------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. 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 | RequestedFor | **String** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. - Query | NonEmployeeCount | **Boolean** | (optional) (default to $false) | Flag that determines whether the API will return a non-employee count associated with the source. + Query | NonEmployeeCount | **Boolean** | (optional) | The flag to determine whether return a non-employee count associate with source. 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: **name, created, sourceId** ### Return type @@ -1439,20 +1441,20 @@ Code | Description | Data Type ### Example ```powershell +$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $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) -$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) -$NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) +$NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) $Sorters = "name,created" # 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, created, sourceId** (optional) # List Non-Employee Sources try { - Get-NonEmployeeSources + Get-NonEmployeeSources -RequestedFor $RequestedFor # Below is a request that includes all optional parameters - # Get-NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + # Get-NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessCriteria.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessCriteria.md index 3a5cd88d6194..4a6c0b59081a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessCriteria.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessCriteria.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $AccessCriteria = Initialize-PSSailpoint.V3AccessCriteria -Name money-in ` - -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] + -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileEntitlement.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileEntitlement.md index ded94541f4a2..733a4a9f8c03 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileEntitlement.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileEntitlement.md @@ -39,7 +39,7 @@ $AccessProfileEntitlement = Initialize-PSSailpoint.V3AccessProfileEntitlement - -Type ENTITLEMENT ` -Privileged false ` -Attribute memberOf ` - -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` -Standalone false ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md index 8219df91dbe4..7f8384e073c8 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $AccessRequest = Initialize-PSSailpoint.V3AccessRequest -RequestedFor null ` -RequestType null ` -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md index e593cddffd6c..0f7506e821d9 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes $AccessRequestItem = Initialize-PSSailpoint.V3AccessRequestItem -Type ACCESS_PROFILE ` -Id 2c9180835d2e5168015d32f890ca1581 ` -Comment Requesting access profile for John Doe ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -RemoveDate 2020-07-11T21:23:15Z ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestResponse.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestResponse.md index b8bb427c3a54..da7e2c24eae3 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestResponse.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestResponse.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccessRequestResponse = Initialize-PSSailpoint.V3AccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] ` - -ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] +$AccessRequestResponse = Initialize-PSSailpoint.V3AccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] ` + -ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestTracking.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestTracking.md index 7107e78bcdcc..9478e76b4ecf 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestTracking.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestTracking.md @@ -27,8 +27,8 @@ Name | Type | Description | Notes ```powershell $AccessRequestTracking = Initialize-PSSailpoint.V3AccessRequestTracking -RequestedFor 2c918084660f45d6016617daa9210584 ` -RequestedItemsDetails { -"type": "ENTITLEMENT", -"id": "779c6fd7171540bba1184e5946112c28" +"type": "ENTITLEMENT", +"id": "779c6fd7171540bba1184e5946112c28" } ` -AttributesHash -1928438224 ` -AccessRequestIds [5d3118c518a44ec7805450d53479ccdb] diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Account.md b/docs/tools/sdk/powershell/Reference/V3/Models/Account.md index e081458520d6..02daab3e7007 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Account.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Account.md @@ -61,7 +61,7 @@ $Account = Initialize-PSSailpoint.V3Account -Id id12345 ` -ConnectionType direct ` -IsMachine true ` -Recommendation null ` - -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` + -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` -Authoritative false ` -Description null ` -Disabled false ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountActivity.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountActivity.md index 16995f6bd82b..d149b4506d1e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountActivity.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountActivity.md @@ -48,7 +48,7 @@ $AccountActivity = Initialize-PSSailpoint.V3AccountActivity -Id 2c9180835d2e516 -Warnings [Some warning, another warning] ` -Items null ` -ExecutionStatus null ` - -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} + -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountActivityItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountActivityItem.md index 50a6ac5cb166..1078908234ae 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountActivityItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountActivityItem.md @@ -51,7 +51,7 @@ $AccountActivityItem = Initialize-PSSailpoint.V3AccountActivityItem -Id 48c5458 -NativeIdentity Sandie.Camero ` -SourceId 2c91808363ef85290164000587130c0c ` -AccountRequestInfo null ` - -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ` + -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ` -RemoveDate 2020-07-11T00:00Z ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountAttribute.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountAttribute.md index bdf91c680d9b..ce5be56c3ff5 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountAttribute.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountAttribute.md @@ -35,10 +35,10 @@ $AccountAttribute = Initialize-PSSailpoint.V3AccountAttribute -SourceName Workd -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountAttributes.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountAttributes.md index 9cc211156f1b..780ab998d95b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountAttributes.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountAttributes.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountAttributes = Initialize-PSSailpoint.V3AccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +$AccountAttributes = Initialize-PSSailpoint.V3AccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md index 35c8a92f6b89..3b9cae031d5f 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 46a6997a7edc..122bd54b08fa 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AggregationResult.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AggregationResult.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AggregationResult = Initialize-PSSailpoint.V3AggregationResult -Aggregations {Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}} ` +$AggregationResult = Initialize-PSSailpoint.V3AggregationResult -Aggregations {Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}} ` -Hits null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AppAllOfAccount.md b/docs/tools/sdk/powershell/Reference/V3/Models/AppAllOfAccount.md index 32e2daa5d980..8360ba81b1af 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AppAllOfAccount.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AppAllOfAccount.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $AppAllOfAccount = Initialize-PSSailpoint.V3AppAllOfAccount -Id 2c9180837dfe6949017e21f3d8cd6d49 ` - -AccountId CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com + -AccountId CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDTOList.md b/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDTOList.md index 247e3e911dbe..d127be67fc78 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDTOList.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDTOList.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AttributeDTOList = Initialize-PSSailpoint.V3AttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] +$AttributeDTOList = Initialize-PSSailpoint.V3AttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/BackupOptions.md b/docs/tools/sdk/powershell/Reference/V3/Models/BackupOptions.md index 3588e79290f1..4e0f2a5fdbe8 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/BackupOptions.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/BackupOptions.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $BackupOptions = Initialize-PSSailpoint.V3BackupOptions -IncludeTypes null ` - -ObjectOptions {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}} + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Base64Decode.md b/docs/tools/sdk/powershell/Reference/V3/Models/Base64Decode.md index ab6f42ae4cb1..025ed8063c4c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Base64Decode.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Base64Decode.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Base64Decode = Initialize-PSSailpoint.V3Base64Decode -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Base64Encode.md b/docs/tools/sdk/powershell/Reference/V3/Models/Base64Encode.md index 9ae1da62b3dc..f16571abaac6 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Base64Encode.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Base64Encode.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Base64Encode = Initialize-PSSailpoint.V3Base64Encode -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/BaseAccount.md b/docs/tools/sdk/powershell/Reference/V3/Models/BaseAccount.md index 13ae5c371b97..9c1cbcbd245f 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/BaseAccount.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/BaseAccount.md @@ -43,10 +43,10 @@ $BaseAccount = Initialize-PSSailpoint.V3BaseAccount -Id 2c91808568c529c60168cca -Privileged false ` -ManuallyCorrelated false ` -PasswordLastSet 2018-06-25T20:22:28.104Z ` - -EntitlementAttributes {moderator=true, admin=true, trust_level=4} ` + -EntitlementAttributes {moderator=true, admin=true, trust_level=4} ` -Created 2018-06-25T20:22:28.104Z ` -SupportsPasswordChange false ` - -AccountAttributes {type=global, admin=true, trust_level=4} + -AccountAttributes {type=global, admin=true, trust_level=4} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/BaseEntitlement.md b/docs/tools/sdk/powershell/Reference/V3/Models/BaseEntitlement.md index 3c5935ec6776..998f651e070b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/BaseEntitlement.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/BaseEntitlement.md @@ -32,11 +32,11 @@ Name | Type | Description | Notes $BaseEntitlement = Initialize-PSSailpoint.V3BaseEntitlement -HasPermissions false ` -Description Cloud engineering ` -Attribute memberOf ` - -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` -Schema group ` -Privileged false ` -Id 2c918084575812550157589064f33b89 ` - -Name CN=Cloud Engineering,DC=sailpoint,DC=COM + -Name CN=Cloud Engineering,DC=sailpoint,DC=COM ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/CampaignFilterDetails.md b/docs/tools/sdk/powershell/Reference/V3/Models/CampaignFilterDetails.md index 9a09044a4061..552f6d249479 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/CampaignFilterDetails.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/CampaignFilterDetails.md @@ -30,10 +30,10 @@ Name | Type | Description | Notes ```powershell $CampaignFilterDetails = Initialize-PSSailpoint.V3CampaignFilterDetails -Id 5ec18cef39020d6fd7a60ad3970aba61 ` -Name Identity Attribute Campaign Filter ` - -Description Campaign filter to certify data based on an identity attribute's specified property. ` + -Description Campaign filter to certify data based on an identity attribute's specified property. ` -Owner SailPoint Support ` -Mode INCLUSION ` - -CriteriaList [{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}] ` + -CriteriaList [{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}] ` -IsSystemFilter false ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/CertificationTask.md b/docs/tools/sdk/powershell/Reference/V3/Models/CertificationTask.md index 1418e1151eea..2f29f75e5851 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/CertificationTask.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/CertificationTask.md @@ -35,7 +35,7 @@ $CertificationTask = Initialize-PSSailpoint.V3CertificationTask -Id 2c918086719 -TargetId 2c918086719eec070171a7e3355a834c ` -Status QUEUED ` -Errors null ` - -ReassignmentTrailDTOs {previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT} ` + -ReassignmentTrailDTOs {previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT} ` -Created 2020-09-24T18:10:47.693Z ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/CompletedApproval.md b/docs/tools/sdk/powershell/Reference/V3/Models/CompletedApproval.md index 4aa9f5f4376d..66fd9ba41cff 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/CompletedApproval.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/CompletedApproval.md @@ -66,7 +66,7 @@ $CompletedApproval = Initialize-PSSailpoint.V3CompletedApproval -Id id12345 ` -CurrentRemoveDate 2020-07-11T00:00Z ` -SodViolationContext null ` -PreApprovalTriggerResult null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Concatenation.md b/docs/tools/sdk/powershell/Reference/V3/Models/Concatenation.md index 95b2a67e984a..1d960e7da076 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Concatenation.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Concatenation.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $Concatenation = Initialize-PSSailpoint.V3Concatenation -Values [John, , Smith] ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Conditional.md b/docs/tools/sdk/powershell/Reference/V3/Models/Conditional.md index 4046d8b183a0..da8c39683967 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Conditional.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Conditional.md @@ -30,7 +30,7 @@ $Conditional = Initialize-PSSailpoint.V3Conditional -Expression ValueA eq Value -PositiveCondition true ` -NegativeCondition false ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ConnectorDetail.md b/docs/tools/sdk/powershell/Reference/V3/Models/ConnectorDetail.md index e339e57b2ad1..06c56251a80c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ConnectorDetail.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ConnectorDetail.md @@ -41,68 +41,68 @@ $ConnectorDetail = Initialize-PSSailpoint.V3ConnectorDetail -Name name ` -Type ServiceNow ` -ClassName class name ` -ScriptName servicenow ` - -ApplicationXml <?xml version='1.0' encoding='UTF-8'?> -<!DOCTYPE Application PUBLIC "sailpoint.dtd" "sailpoint.dtd"> -<Application connector="sailpoint.connector.OpenConnectorAdapter" name="custom Atlassian Suite - Cloud" type="custom Atlassian Suite - Cloud"/> + -ApplicationXml + + ` - -CorrelationConfigXml <?xml version='1.0' encoding='UTF-8'?> -<!-- Copyright (C) 2021 SailPoint Technologies, Inc. All rights reserved. --> + -CorrelationConfigXml + -<!DOCTYPE CorrelationConfig PUBLIC "sailpoint.dtd" "sailpoint.dtd"> + -<CorrelationConfig name="custom Atlassian Suite - Cloud Account Correlation Config"> - <AttributeAssignments> - <Filter operation="EQ" property="email" value="mail"/> - <Filter operation="EQ" property="empId" value="employeeNumber"/> - <Filter operation="EQ" property="displayName" value="cn"/> - </AttributeAssignments> -</CorrelationConfig> + + + + + + + ` - -SourceConfigXml <?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig"> - <BaseConfig> - <Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/> - </BaseConfig> + -SourceConfigXml
+ + + -</Form> ` - -SourceConfig <?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig"> - <BaseConfig> - <Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/> - </BaseConfig> +
` + -SourceConfig
+ + + -</Form> ` +
` -SourceConfigFrom sp-connect ` -S3Location custom-connector/scriptname ` -UploadedFiles [pod/org/connectorFiles/testconnector/test1.jar] ` -FileUpload true ` -DirectConnect true ` - -TranslationProperties {de=# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved. -# DO NOT EDIT. This file is generated by "sailpointTranslate" command. -menuLabel_ConnectionSettings=Verbindungseinstellungen -menuLabel_AggregationSettings=Aggregationseinstellungen -sectionLabel_AuthenticationSettings=Verbindungseinstellungen -sectionLabel_AggregationSettings=Aggregationseinstellungen -sectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.<br><br>Geben Sie bei <strong>Zeit\u00fcberschreitung bei Verbindung</strong> die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.<br><br>Geben Sie die <strong>Host-URL</strong> der Delinea-SCIM-Serverquelle ein.<br><br>Geben Sie den <strong>API-Token</strong> der Quelle zur Authentifizierung ein. -sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.<br><br>Geben Sie in das Feld <strong>Seitengr\u00f6\u00dfe</strong> die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.<br>\n<br>Geben Sie im <strong>Kontofilter</strong> die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"<br><br>Geben Sie im <strong>Gruppenfilter</strong> die Gruppenfilterbedingungen an. Beispiel: displayName sw "S". -placeHolder_accAggregation=userName sw "S" -placeHolder_grpAggregation=displayName sw "S" -placeHolder_host=https://{Delinea_SCIM_Server_host}/v2 -docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen -docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter -HostURL=Host-URL -ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung -API_TOKEN=API-Token -JSONPathMapping=JSON-Path-Attribut-Mapping -FilterConditionForAccounts=Kontofilter -FilterConditionForGroups=Gruppenfilter -Page_Size=Seitengr\u00f6\u00dfe -SchemaAttribute=Schema-Attribut -JSONpath=JSON-Pfad -ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management.} ` - -ConnectorMetadata {supportedUI=EXTJS, platform=ccg, shortDesc=connector description} ` + -TranslationProperties {de=# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved. +# DO NOT EDIT. This file is generated by "sailpointTranslate" command. +menuLabel_ConnectionSettings=Verbindungseinstellungen +menuLabel_AggregationSettings=Aggregationseinstellungen +sectionLabel_AuthenticationSettings=Verbindungseinstellungen +sectionLabel_AggregationSettings=Aggregationseinstellungen +sectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.

Geben Sie bei Zeit\u00fcberschreitung bei Verbindung die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.

Geben Sie die Host-URL der Delinea-SCIM-Serverquelle ein.

Geben Sie den API-Token der Quelle zur Authentifizierung ein. +sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.

Geben Sie in das Feld Seitengr\u00f6\u00dfe die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.
\n
Geben Sie im Kontofilter die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"

Geben Sie im Gruppenfilter die Gruppenfilterbedingungen an. Beispiel: displayName sw "S". +placeHolder_accAggregation=userName sw "S" +placeHolder_grpAggregation=displayName sw "S" +placeHolder_host=https://{Delinea_SCIM_Server_host}/v2 +docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen +docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter +HostURL=Host-URL +ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung +API_TOKEN=API-Token +JSONPathMapping=JSON-Path-Attribut-Mapping +FilterConditionForAccounts=Kontofilter +FilterConditionForGroups=Gruppenfilter +Page_Size=Seitengr\u00f6\u00dfe +SchemaAttribute=Schema-Attribut +JSONpath=JSON-Pfad +ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management.} ` + -ConnectorMetadata {supportedUI=EXTJS, platform=ccg, shortDesc=connector description} ` -Status RELEASED ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/CreateExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/CreateExternalExecuteWorkflowRequest.md index 3aa4bac32fdf..e5506f599d2e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/CreateExternalExecuteWorkflowRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/CreateExternalExecuteWorkflowRequest.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$CreateExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V3CreateExternalExecuteWorkflowRequest -VarInput {customAttribute1=value1, customAttribute2=value2} +$CreateExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V3CreateExternalExecuteWorkflowRequest -VarInput {customAttribute1=value1, customAttribute2=value2} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md index 8e5163d9afca..79df95e7ac62 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/CreateSavedSearchRequest.md @@ -37,10 +37,10 @@ $CreateSavedSearchRequest = Initialize-PSSailpoint.V3CreateSavedSearchRequest - -Created 2018-06-25T20:22:28.104Z ` -Modified 2018-06-25T20:22:28.104Z ` -Indices [identities] ` - -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` -Query @accounts(disabled:true) ` -Fields [disabled] ` - -OrderBy {identity=[lastName, firstName], role=[name]} ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` -Sort [displayName] ` -Filters null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/CreateWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/CreateWorkflowRequest.md index 5f237cfaaa9a..a4ea7e6a66fa 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/CreateWorkflowRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/CreateWorkflowRequest.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes ```powershell $CreateWorkflowRequest = Initialize-PSSailpoint.V3CreateWorkflowRequest -Name Send Email ` -Owner null ` - -Description Send an email to the identity who's attributes changed. ` + -Description Send an email to the identity who's attributes changed. ` -Definition null ` -Enabled false ` -Trigger null diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/DateCompare.md b/docs/tools/sdk/powershell/Reference/V3/Models/DateCompare.md index e36dddc3687b..ba01d45bcfe4 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/DateCompare.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/DateCompare.md @@ -34,7 +34,7 @@ $DateCompare = Initialize-PSSailpoint.V3DateCompare -FirstDate null ` -PositiveCondition true ` -NegativeCondition false ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/DateCompareFirstDate.md b/docs/tools/sdk/powershell/Reference/V3/Models/DateCompareFirstDate.md index 36b87f5aff6a..60da4cb5cf4f 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/DateCompareFirstDate.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/DateCompareFirstDate.md @@ -37,10 +37,10 @@ $DateCompareFirstDate = Initialize-PSSailpoint.V3DateCompareFirstDate -SourceNa -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` -InputFormat null ` -OutputFormat null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/DateCompareSecondDate.md b/docs/tools/sdk/powershell/Reference/V3/Models/DateCompareSecondDate.md index 1a64627e75ae..8d14bcf1cce1 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/DateCompareSecondDate.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/DateCompareSecondDate.md @@ -37,10 +37,10 @@ $DateCompareSecondDate = Initialize-PSSailpoint.V3DateCompareSecondDate -Source -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` -InputFormat null ` -OutputFormat null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/DateFormat.md b/docs/tools/sdk/powershell/Reference/V3/Models/DateFormat.md index cf09d0bb1edb..10794fa0142d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/DateFormat.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/DateFormat.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $DateFormat = Initialize-PSSailpoint.V3DateFormat -InputFormat null ` -OutputFormat null ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/DateMath.md b/docs/tools/sdk/powershell/Reference/V3/Models/DateMath.md index 36cf2082fdb8..27fca59d3645 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/DateMath.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/DateMath.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $DateMath = Initialize-PSSailpoint.V3DateMath -Expression now+1w ` -RoundUp false ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/DecomposeDiacriticalMarks.md b/docs/tools/sdk/powershell/Reference/V3/Models/DecomposeDiacriticalMarks.md index d934b8453786..e7cfcfca5730 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/DecomposeDiacriticalMarks.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/DecomposeDiacriticalMarks.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $DecomposeDiacriticalMarks = Initialize-PSSailpoint.V3DecomposeDiacriticalMarks -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/E164phone.md b/docs/tools/sdk/powershell/Reference/V3/Models/E164phone.md index b465509e1dfc..6af3b4779f4e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/E164phone.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/E164phone.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $E164phone = Initialize-PSSailpoint.V3E164phone -DefaultRegion US ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Entitlement.md b/docs/tools/sdk/powershell/Reference/V3/Models/Entitlement.md index 184d7c62c24b..b6f3dce6eaeb 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Entitlement.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Entitlement.md @@ -38,15 +38,15 @@ Name | Type | Description | Notes $Entitlement = Initialize-PSSailpoint.V3Entitlement -Id 2c91808874ff91550175097daaec161c ` -Name LauncherTest2 ` -Attribute memberOf ` - -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` -SourceSchemaObjectType group ` - -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` -Privileged true ` -CloudGoverned true ` -Created 2020-10-08T18:33:52.029Z ` -Modified 2020-10-08T18:33:52.029Z ` -Source null ` - -Attributes {fieldName=fieldValue} ` + -Attributes {fieldName=fieldValue} ` -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` -DirectPermissions null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementDto.md b/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementDto.md index 5eb8d4e32c14..4e68db3dc836 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementDto.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementDto.md @@ -38,9 +38,9 @@ $EntitlementDto = Initialize-PSSailpoint.V3EntitlementDto -Id id12345 ` -Created 2015-05-28T14:07:17Z ` -Modified 2015-05-28T14:07:17Z ` -Attribute authorizationType ` - -Value CN=Users,dc=sailpoint,dc=com ` + -Value CN=Users,dc=sailpoint,dc=com ` -Description Active Directory DC ` - -Attributes {GroupType=Security, sAMAccountName=Buyer} ` + -Attributes {GroupType=Security, sAMAccountName=Buyer} ` -SourceSchemaObjectType group ` -Privileged false ` -CloudGoverned false ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef.md index 820e5edffe41..49358aeefbb4 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $EntitlementRef = Initialize-PSSailpoint.V3EntitlementRef -Type ENTITLEMENT ` -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef1.md b/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef1.md index af424bf120fa..69c352d5c3af 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef1.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementRef1.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $EntitlementRef1 = Initialize-PSSailpoint.V3EntitlementRef1 -Type ENTITLEMENT ` -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementSummary.md b/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementSummary.md index fac7fdd1410c..f67a7bf9eb9e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementSummary.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/EntitlementSummary.md @@ -39,7 +39,7 @@ $EntitlementSummary = Initialize-PSSailpoint.V3EntitlementSummary -Id 2c9180856 -Type ENTITLEMENT ` -Privileged false ` -Attribute memberOf ` - -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` -Standalone false ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Event.md b/docs/tools/sdk/powershell/Reference/V3/Models/Event.md index 3a61e056ad05..a347471bd228 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Event.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Event.md @@ -50,7 +50,7 @@ $ModelEvent = Initialize-PSSailpoint.V3ModelEvent -Id 2c91808375d8e80a0175e1f88 -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` -IpAddress 52.52.97.85 ` -Details 73b65dfbed1842548c207432a18c84b0 ` - -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` + -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` -Objects null ` -Operation ADD ` -Status PASSED ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/EventAttributes.md b/docs/tools/sdk/powershell/Reference/V3/Models/EventAttributes.md index 1ecc39e732ce..c54f4272c9cc 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/EventAttributes.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/EventAttributes.md @@ -26,8 +26,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $EventAttributes = Initialize-PSSailpoint.V3EventAttributes -Id idn:identity-attributes-changed ` - -VarFilter $.changes[?(@.attribute == 'manager')] ` - -Description Triggered when an identity's manager attribute changes ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` + -Description Triggered when an identity's manager attribute changes ` -AttributeToFilter LifecycleState ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/EventDocument.md b/docs/tools/sdk/powershell/Reference/V3/Models/EventDocument.md index 6102bc6e8fd5..e81d5e976b1d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/EventDocument.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/EventDocument.md @@ -50,7 +50,7 @@ $EventDocument = Initialize-PSSailpoint.V3EventDocument -Id 2c91808375d8e80a017 -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` -IpAddress 52.52.97.85 ` -Details 73b65dfbed1842548c207432a18c84b0 ` - -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` + -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` -Objects null ` -Operation ADD ` -Status PASSED ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteria.md b/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteria.md index 16cc11edba12..b87ece3bb236 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteria.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteria.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ExceptionCriteria = Initialize-PSSailpoint.V3ExceptionCriteria -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] +$ExceptionCriteria = Initialize-PSSailpoint.V3ExceptionCriteria -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteriaAccess.md index c36e9c7a78b3..416322b16c03 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteriaAccess.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteriaAccess.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes ```powershell $ExceptionCriteriaAccess = Initialize-PSSailpoint.V3ExceptionCriteriaAccess -Type null ` -Id 2c91808568c529c60168cca6f90c1313 ` - -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` -Existing true ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteriaCriteriaListInner.md index ee122f79b4d6..6dd84659ec6f 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteriaCriteriaListInner.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ExceptionCriteriaCriteriaListInner.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes ```powershell $ExceptionCriteriaCriteriaListInner = Initialize-PSSailpoint.V3ExceptionCriteriaCriteriaListInner -Type ENTITLEMENT ` -Id 2c91808568c529c60168cca6f90c1313 ` - -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` -Existing true ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/FieldDetailsDto.md b/docs/tools/sdk/powershell/Reference/V3/Models/FieldDetailsDto.md index dfb5606fbc99..774e484b06c2 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/FieldDetailsDto.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/FieldDetailsDto.md @@ -28,8 +28,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $FieldDetailsDto = Initialize-PSSailpoint.V3FieldDetailsDto -Name userName ` - -Transform {type=rule, attributes={name=Create Unique LDAP Attribute}} ` - -Attributes {template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true} ` + -Transform {type=rule, attributes={name=Create Unique LDAP Attribute}} ` + -Attributes {template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true} ` -IsRequired false ` -Type string ` -IsMultiValued false diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/FirstValid.md b/docs/tools/sdk/powershell/Reference/V3/Models/FirstValid.md index 3665815d3305..f59c45ec3bf3 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/FirstValid.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/FirstValid.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$FirstValid = Initialize-PSSailpoint.V3FirstValid -Values [{attributes={sourceName=Active Directory, attributeName=sAMAccountName}, type=accountAttribute}, {attributes={sourceName=Okta, attributeName=login}, type=accountAttribute}, {attributes={sourceName=HR Source, attributeName=employeeID}, type=accountAttribute}] ` +$FirstValid = Initialize-PSSailpoint.V3FirstValid -Values [{attributes={sourceName=Active Directory, attributeName=sAMAccountName}, type=accountAttribute}, {attributes={sourceName=Okta, attributeName=login}, type=accountAttribute}, {attributes={sourceName=HR Source, attributeName=employeeID}, type=accountAttribute}] ` -IgnoreErrors false ` -RequiresPeriodicRefresh false ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ISO3166.md b/docs/tools/sdk/powershell/Reference/V3/Models/ISO3166.md index 467373e4a0cb..047cbd5b0826 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ISO3166.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ISO3166.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $ISO3166 = Initialize-PSSailpoint.V3ISO3166 -Format alpha2 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAccess.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAccess.md index cb019f549050..5487ae6769cd 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAccess.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAccess.md @@ -44,7 +44,7 @@ $IdentityAccess = Initialize-PSSailpoint.V3IdentityAccess -Id 2c91808568c529c60 -Revocable null ` -Privileged false ` -Attribute memberOf ` - -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` -Standalone false ` -Disabled null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttribute.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttribute.md index 501c80fbcaf0..188145fe3eb8 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttribute.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttribute.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $IdentityAttribute = Initialize-PSSailpoint.V3IdentityAttribute -Name email ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md index 7ba016fe415b..f5693610feed 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'IdentityAt Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**Enabled** | **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] **AttributeTransforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md index f884829601e7..f1622242f6b4 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'Identit Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] +**IdentityAttributeName** | **String** | Name of the identity attribute. | [optional] **TransformDefinition** | [**TransformDefinition**](transform-definition) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityDocument.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityDocument.md index b0c2cb4ce51b..8d3e1c462472 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityDocument.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityDocument.md @@ -77,7 +77,7 @@ $IdentityDocument = Initialize-PSSailpoint.V3IdentityDocument -Id 2c91808568c52 -IsManager false ` -IdentityProfile null ` -Source null ` - -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` + -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` -Disabled false ` -Locked false ` -ProcessingState ERROR ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md index 4290c57af4a0..0dc3f7dd2189 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'I Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | Task result ID. | [optional] -**ReportName** | **String** | Report name. | [optional] +**TaskResultId** | **String** | The id of the task result. | [optional] +**ReportName** | **String** | The name of the report. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md index 020457df8fb3..332626ceb26b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | Identity profile's description. | [optional] +**Description** | **String** | The description of the Identity Profile. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | Identity profile's priority. | [optional] +**Priority** | **Int64** | The priority for an Identity Profile. | [optional] **AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] -**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] +**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md index ab7a1b937ff4..ef2d8c38798e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] -**Id** | **String** | Authoritative source's ID. | [optional] -**Name** | **String** | Authoritative source's name. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] +**Id** | **String** | ID of the object to which this reference applies | [optional] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md index 000fd33d1002..e3a823081ebf 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'Identity Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Owner's object type. | [optional] -**Id** | **String** | Owner's ID. | [optional] -**Name** | **String** | Owner's name. | [optional] +**Type** | **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] +**Id** | **String** | ID of the object to which this reference applies | [optional] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess.md index a407f2a44ebb..8ee2ae4e73db 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $IdentityWithNewAccess = Initialize-PSSailpoint.V3IdentityWithNewAccess -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}] + -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}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess1.md index d5731ff8945a..c3f5cf39d70c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess1.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccess1.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $IdentityWithNewAccess1 = Initialize-PSSailpoint.V3IdentityWithNewAccess1 -IdentityId 2c91809050db617d0150e0bf3215385e ` -AccessRefs null ` - -ClientMetadata {clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} + -ClientMetadata {clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md index e3fb7fe0c5f8..de12002ddb33 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityWithNewAccessAccessRefsInner.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $IdentityWithNewAccessAccessRefsInner = Initialize-PSSailpoint.V3IdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT ` -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md index 0b28586aa748..56bfa5fd6af2 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md @@ -48,7 +48,7 @@ $IdpDetails = Initialize-PSSailpoint.V3IdpDetails -Role SAML_IDP ` -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` -MappingAttribute email ` -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` - -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IndexOf.md b/docs/tools/sdk/powershell/Reference/V3/Models/IndexOf.md index 740fee3c9cf9..4e4bc1b4183c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IndexOf.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IndexOf.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $IndexOf = Initialize-PSSailpoint.V3IndexOf -Substring admin_ ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/InnerHit.md b/docs/tools/sdk/powershell/Reference/V3/Models/InnerHit.md index fffa9528f09c..9737f2939a0b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/InnerHit.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/InnerHit.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$InnerHit = Initialize-PSSailpoint.V3InnerHit -Query source.name:\"Active Directory\" ` +$InnerHit = Initialize-PSSailpoint.V3InnerHit -Query source.name:\"Active Directory\" ` -Type access ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/JITConfiguration.md b/docs/tools/sdk/powershell/Reference/V3/Models/JITConfiguration.md index 32002c1d6e4c..3a2c0a62d84a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/JITConfiguration.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/JITConfiguration.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $JITConfiguration = Initialize-PSSailpoint.V3JITConfiguration -Enabled false ` -SourceId 2c9180857377ed2901739c12a2da5ac8 ` - -SourceAttributeMappings {firstName=okta.firstName, lastName=okta.lastName, email=okta.email} + -SourceAttributeMappings {firstName=okta.firstName, lastName=okta.lastName, email=okta.email} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/KbaAnswerResponseItem.md index c74ca4b94474..7cffefa3747d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/KbaAnswerResponseItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/KbaAnswerResponseItem.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $KbaAnswerResponseItem = Initialize-PSSailpoint.V3KbaAnswerResponseItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` - -Question [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -Question [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` -HasAnswer true ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/KbaAuthResponse.md b/docs/tools/sdk/powershell/Reference/V3/Models/KbaAuthResponse.md index e01fe2305378..20bc66508a97 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/KbaAuthResponse.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/KbaAuthResponse.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$KbaAuthResponse = Initialize-PSSailpoint.V3KbaAuthResponse -KbaAuthResponseItems [{questionId=089899f13a8f4da7824996191587bab9, isVerified=false}] ` +$KbaAuthResponse = Initialize-PSSailpoint.V3KbaAuthResponse -KbaAuthResponseItems [{questionId=089899f13a8f4da7824996191587bab9, isVerified=false}] ` -Status PENDING ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/KbaQuestion.md b/docs/tools/sdk/powershell/Reference/V3/Models/KbaQuestion.md index fafe422a8752..8cfda9531b31 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/KbaQuestion.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/KbaQuestion.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $KbaQuestion = Initialize-PSSailpoint.V3KbaQuestion -Id 143cfd3b-c23f-426b-ae5f-d3db06fa5919 ` - -Text [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -Text [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` -HasAnswer true ` -NumAnswers 5 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/LeftPad.md b/docs/tools/sdk/powershell/Reference/V3/Models/LeftPad.md index 561aec19640e..84646e1eaaec 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/LeftPad.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/LeftPad.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $LeftPad = Initialize-PSSailpoint.V3LeftPad -Length 4 ` -Padding 0 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V3/Models/ListCompleteWorkflowLibrary200ResponseInner.md index 4f325c17738f..d57fb9768320 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ListCompleteWorkflowLibrary200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -38,7 +38,7 @@ $ListCompleteWorkflowLibrary200ResponseInner = Initialize-PSSailpoint.V3ListComp -Name Compare Boolean Values ` -Type OPERATOR ` -Description Compare two boolean values and decide what happens based on the result. ` - -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ` + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ` -ExampleOutput null ` -Deprecated null ` -DeprecatedBy null ` @@ -46,7 +46,7 @@ $ListCompleteWorkflowLibrary200ResponseInner = Initialize-PSSailpoint.V3ListComp -IsSimulationEnabled null ` -IsDynamicSchema false ` -OutputSchema null ` - -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Lookup.md b/docs/tools/sdk/powershell/Reference/V3/Models/Lookup.md index 8ad7e9f32b47..ad4dff4e48b6 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Lookup.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Lookup.md @@ -24,9 +24,9 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$Lookup = Initialize-PSSailpoint.V3Lookup -Table {USA=Americas, FRA=EMEA, AUS=APAC, default=Unknown Region} ` +$Lookup = Initialize-PSSailpoint.V3Lookup -Table {USA=Americas, FRA=EMEA, AUS=APAC, default=Unknown Region} ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Lower.md b/docs/tools/sdk/powershell/Reference/V3/Models/Lower.md index 79a59d744b53..6e194f8ad388 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Lower.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Lower.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Lower = Initialize-PSSailpoint.V3Lower -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ManagedClientStatus.md b/docs/tools/sdk/powershell/Reference/V3/Models/ManagedClientStatus.md index 10d9d4e3a432..71914c338951 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ManagedClientStatus.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ManagedClientStatus.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ManagedClientStatus = Initialize-PSSailpoint.V3ManagedClientStatus -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=, state=null, status=NORMAL, uuid=null, product=idn, va_version=null, platform_version=2, os_version=2345.3.1, os_type=flatcar, hypervisor=unknown} ` +$ManagedClientStatus = Initialize-PSSailpoint.V3ManagedClientStatus -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=, state=null, status=NORMAL, uuid=null, product=idn, va_version=null, platform_version=2, os_version=2345.3.1, os_type=flatcar, hypervisor=unknown} ` -Status null ` -Type null ` -Timestamp 2020-01-01T00:00Z diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ManagedCluster.md b/docs/tools/sdk/powershell/Reference/V3/Models/ManagedCluster.md index 81e90fcb5141..f2b7bc8ea7a5 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ManagedCluster.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ManagedCluster.md @@ -51,7 +51,7 @@ $ManagedCluster = Initialize-PSSailpoint.V3ManagedCluster -Id e1ff7bb24c934240b -Pod megapod-useast1 ` -Org denali ` -Type null ` - -Configuration {clusterExternalId=e1ff7bb24c934240bbf55e1aa39e41c5, clusterType=sqsCluster, gmtOffset=-5} ` + -Configuration {clusterExternalId=e1ff7bb24c934240bbf55e1aa39e41c5, clusterType=sqsCluster, gmtOffset=-5} ` -KeyPair null ` -Attributes null ` -Description A short description of the managed cluster. ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ManagedClusterRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/ManagedClusterRequest.md index 22584f8c77d5..ffee317388a8 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ManagedClusterRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ManagedClusterRequest.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes ```powershell $ManagedClusterRequest = Initialize-PSSailpoint.V3ManagedClusterRequest -Name Managed Cluster Name ` -Type null ` - -Configuration {clusterExternalId=externalId, ccgVersion=77.0.0} ` + -Configuration {clusterExternalId=externalId, ccgVersion=77.0.0} ` -Description A short description of the managed cluster. ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ManualDiscoverApplications.md b/docs/tools/sdk/powershell/Reference/V3/Models/ManualDiscoverApplications.md index 612584e1a783..fcd2b3839f61 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ManualDiscoverApplications.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ManualDiscoverApplications.md @@ -23,8 +23,8 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ManualDiscoverApplications = Initialize-PSSailpoint.V3ManualDiscoverApplications -File application_name,description -"Sample App","This is a sample description for Sample App." -"Another App","Description for Another App." +"Sample App","This is a sample description for Sample App." +"Another App","Description for Another App." ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/MfaDuoConfig.md b/docs/tools/sdk/powershell/Reference/V3/Models/MfaDuoConfig.md index f4ce8352e547..75ba1893e6a2 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/MfaDuoConfig.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/MfaDuoConfig.md @@ -32,7 +32,7 @@ $MfaDuoConfig = Initialize-PSSailpoint.V3MfaDuoConfig -MfaMethod duo-web ` -VarHost example.com ` -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` -IdentityAttribute email ` - -ConfigProperties {skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} + -ConfigProperties {skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NameNormalizer.md b/docs/tools/sdk/powershell/Reference/V3/Models/NameNormalizer.md index 04179e1bfd62..e1cddfcba6a4 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NameNormalizer.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NameNormalizer.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $NameNormalizer = Initialize-PSSailpoint.V3NameNormalizer -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRecord.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRecord.md index ea43785424cb..3b558c6ca1a9 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRecord.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRecord.md @@ -42,7 +42,7 @@ $NonEmployeeRecord = Initialize-PSSailpoint.V3NonEmployeeRecord -Id ef38f94347e -Phone 5125555555 ` -Manager jane.doe ` -SourceId 2c91808568c529c60168cca6f90c1313 ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -StartDate 2019-08-23T18:52:59.162Z ` -EndDate 2020-08-23T18:52:59.162Z ` -Modified 2019-08-23T18:52:59.162Z ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequest.md index 8090faffc955..69b7beaa9a80 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequest.md @@ -52,7 +52,7 @@ $NonEmployeeRequest = Initialize-PSSailpoint.V3NonEmployeeRequest -Id a0303682- -Phone 5125555555 ` -Manager jane.doe ` -NonEmployeeSource null ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -ApprovalItems null ` -ApprovalStatus null ` -Comment approved ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestBody.md index 5c1fb4a4f2b7..00b342f1a7eb 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestBody.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestBody.md @@ -38,7 +38,7 @@ $NonEmployeeRequestBody = Initialize-PSSailpoint.V3NonEmployeeRequestBody -Acco -Phone 5125555555 ` -Manager jane.doe ` -SourceId 2c91808568c529c60168cca6f90c1313 ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -StartDate 2020-03-24T00:00-05:00 ` -EndDate 2021-03-25T00:00-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index bb9eb8a1365c..071f0e39af08 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -47,12 +47,12 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeReq -Phone 5125555555 ` -Manager jane.doe ` -NonEmployeeSource null ` - -VarData {description=Auditing} ` + -VarData {description=Auditing} ` -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/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeSourceWithNECount.md index 4cce4ddd4ad8..4e5b4bae238b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeSourceWithNECount.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeSourceWithNECount.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes **AccountManagers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] **Modified** | **System.DateTime** | When the request was last modified. | [optional] **Created** | **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] +**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ObjectMappingBulkPatchRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/ObjectMappingBulkPatchRequest.md index a92b2583cf16..374a7ca573d0 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ObjectMappingBulkPatchRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ObjectMappingBulkPatchRequest.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ObjectMappingBulkPatchRequest = Initialize-PSSailpoint.V3ObjectMappingBulkPatchRequest -Patches {603b1a61-d03d-4ed1-864f-a508fbd1995d=[{op=replace, path=/enabled, value=true}], 00bece34-f50d-4227-8878-76f620b5a971=[{op=replace, path=/targetValue, value=New Target Value}]} +$ObjectMappingBulkPatchRequest = Initialize-PSSailpoint.V3ObjectMappingBulkPatchRequest -Patches {603b1a61-d03d-4ed1-864f-a508fbd1995d=[{op=replace, path=/enabled, value=true}], 00bece34-f50d-4227-8878-76f620b5a971=[{op=replace, path=/targetValue, value=New Target Value}]} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/OriginalRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/OriginalRequest.md index 71eb43e42b09..998cb308d909 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/OriginalRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/OriginalRequest.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$OriginalRequest = Initialize-PSSailpoint.V3OriginalRequest -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` +$OriginalRequest = Initialize-PSSailpoint.V3OriginalRequest -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -Result null ` -AttributeRequests null ` -Op add ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/PasswordChangeRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/PasswordChangeRequest.md index 7602ebc8eb35..6a13b4d58f26 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/PasswordChangeRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/PasswordChangeRequest.md @@ -27,9 +27,9 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $PasswordChangeRequest = Initialize-PSSailpoint.V3PasswordChangeRequest -IdentityId 8a807d4c73c545510173c545f0a002ff ` - -EncryptedPassword XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== ` + -EncryptedPassword XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== ` -PublicKeyId YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 ` - -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -SourceId 8a807d4c73c545510173c545d4b60246 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/PasswordInfoAccount.md b/docs/tools/sdk/powershell/Reference/V3/Models/PasswordInfoAccount.md index e406459e06c5..f79f6e22e090 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/PasswordInfoAccount.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/PasswordInfoAccount.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$PasswordInfoAccount = Initialize-PSSailpoint.V3PasswordInfoAccount -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` +$PasswordInfoAccount = Initialize-PSSailpoint.V3PasswordInfoAccount -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` -AccountName Abby.Smith ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ProcessingDetails.md b/docs/tools/sdk/powershell/Reference/V3/Models/ProcessingDetails.md index c4665b29d530..057de1d1541b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ProcessingDetails.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ProcessingDetails.md @@ -29,8 +29,8 @@ Name | Type | Description | Notes $ProcessingDetails = Initialize-PSSailpoint.V3ProcessingDetails -Date 2018-06-25T20:22:28.104Z ` -Stage In Process ` -RetryCount 0 ` - -VarStackTrace <stack trace> ` - -Message <message> + -VarStackTrace ` + -Message ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningConfig.md b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningConfig.md index 5863aacfb6c2..fcc225fb7d0b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningConfig.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningConfig.md @@ -27,7 +27,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ProvisioningConfig = Initialize-PSSailpoint.V3ProvisioningConfig -UniversalManager true ` - -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` + -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` -PlanInitializerScript null ` -NoProvisioningRequests true ` -ProvisioningRequestExpiration 7 diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningConfigPlanInitializerScript.md index 04f58980ef76..28d9e4888f7c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningConfigPlanInitializerScript.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningConfigPlanInitializerScript.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ProvisioningConfigPlanInitializerScript = Initialize-PSSailpoint.V3ProvisioningConfigPlanInitializerScript -Source <?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source> +$ProvisioningConfigPlanInitializerScript = Initialize-PSSailpoint.V3ProvisioningConfigPlanInitializerScript -Source \r\n\r\n\r\n Before Provisioning Rule which changes disables and enables to a modify.\r\n ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RandomAlphaNumeric.md b/docs/tools/sdk/powershell/Reference/V3/Models/RandomAlphaNumeric.md index 841736fe03ed..cff7986bed3a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/RandomAlphaNumeric.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RandomAlphaNumeric.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $RandomAlphaNumeric = Initialize-PSSailpoint.V3RandomAlphaNumeric -Length 10 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RandomNumeric.md b/docs/tools/sdk/powershell/Reference/V3/Models/RandomNumeric.md index bf5ef312d7a8..bb9d033b2a7c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/RandomNumeric.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RandomNumeric.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $RandomNumeric = Initialize-PSSailpoint.V3RandomNumeric -Length 10 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Reference.md b/docs/tools/sdk/powershell/Reference/V3/Models/Reference.md index 8c818e50eb92..eb9c2b8ac6c9 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Reference.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Reference.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $Reference = Initialize-PSSailpoint.V3Reference -Id Existing Transform ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Replace.md b/docs/tools/sdk/powershell/Reference/V3/Models/Replace.md index f6b1d80e0720..6e9bb70c1f10 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Replace.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Replace.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $Replace = Initialize-PSSailpoint.V3Replace -Regex [^a-zA-Z] ` -Replacement ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ReplaceAll.md b/docs/tools/sdk/powershell/Reference/V3/Models/ReplaceAll.md index f7bf429f8514..b3c467b98ff7 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ReplaceAll.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ReplaceAll.md @@ -24,9 +24,9 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ReplaceAll = Initialize-PSSailpoint.V3ReplaceAll -Table {-= , "=', ñ=n} ` +$ReplaceAll = Initialize-PSSailpoint.V3ReplaceAll -Table {-= , "=', ñ=n} ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemStatus.md b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemStatus.md index 91d4d72a76c8..db642fae7661 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemStatus.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemStatus.md @@ -68,7 +68,7 @@ $RequestedItemStatus = Initialize-PSSailpoint.V3RequestedItemStatus -Name Acces -RemoveDate 2019-10-23T00:00Z ` -Cancelable true ` -AccessRequestId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` - -ClientMetadata {key1=value1, key2=value2} + -ClientMetadata {key1=value1, key2=value2} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ReviewableEntitlement.md b/docs/tools/sdk/powershell/Reference/V3/Models/ReviewableEntitlement.md index 08a013bafc4c..63cc6eb79e0b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ReviewableEntitlement.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ReviewableEntitlement.md @@ -40,12 +40,12 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $ReviewableEntitlement = Initialize-PSSailpoint.V3ReviewableEntitlement -Id 2c918085718230600171993742c63558 ` - -Name CN=entitlement.bbb7c650 ` + -Name CN=entitlement.bbb7c650 ` -Description Gives read/write access to the company database ` -Privileged false ` -Owner null ` -AttributeName memberOf ` - -AttributeValue CN=entitlement.bbb7c650 ` + -AttributeValue CN=entitlement.bbb7c650 ` -SourceSchemaObjectType groups ` -SourceName ODS-AD-Source ` -SourceType Active Directory - Direct ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ReviewableEntitlementAccount.md b/docs/tools/sdk/powershell/Reference/V3/Models/ReviewableEntitlementAccount.md index 4337d7b50d5b..cd4d310a31c1 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ReviewableEntitlementAccount.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ReviewableEntitlementAccount.md @@ -33,7 +33,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$ReviewableEntitlementAccount = Initialize-PSSailpoint.V3ReviewableEntitlementAccount -NativeIdentity CN=Alison Ferguso ` +$ReviewableEntitlementAccount = Initialize-PSSailpoint.V3ReviewableEntitlementAccount -NativeIdentity CN=Alison Ferguso ` -Disabled false ` -Locked false ` -Type null ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RightPad.md b/docs/tools/sdk/powershell/Reference/V3/Models/RightPad.md index e6772d911386..3c4e8a38b61e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/RightPad.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RightPad.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $RightPad = Initialize-PSSailpoint.V3RightPad -Length 4 ` -Padding 0 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Role.md b/docs/tools/sdk/powershell/Reference/V3/Models/Role.md index 0bb41a0b6d3c..996776ecf016 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Role.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Role.md @@ -48,7 +48,7 @@ $Role = Initialize-PSSailpoint.V3Role -Id 2c918086749d78830174a1a40e121518 ` -AccessProfiles null ` -Entitlements null ` -Membership null ` - -LegacyMembershipInfo {type=IDENTITY_LIST} ` + -LegacyMembershipInfo {type=IDENTITY_LIST} ` -Enabled true ` -Requestable true ` -AccessRequestConfig null ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RoleDocumentAllOfEntitlements.md b/docs/tools/sdk/powershell/Reference/V3/Models/RoleDocumentAllOfEntitlements.md index d01debd49c79..4ca07d8ac540 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/RoleDocumentAllOfEntitlements.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RoleDocumentAllOfEntitlements.md @@ -34,11 +34,11 @@ Name | Type | Description | Notes $RoleDocumentAllOfEntitlements = Initialize-PSSailpoint.V3RoleDocumentAllOfEntitlements -HasPermissions false ` -Description Cloud engineering ` -Attribute memberOf ` - -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` -Schema group ` -Privileged false ` -Id 2c918084575812550157589064f33b89 ` - -Name CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Name CN=Cloud Engineering,DC=sailpoint,DC=COM ` -SourceSchemaObjectType group ` -Hash c6fab95235584cca98a454a2f51e5683bc77d6a0 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RoleDocumentAllOfEntitlements1.md b/docs/tools/sdk/powershell/Reference/V3/Models/RoleDocumentAllOfEntitlements1.md index 2ebee51dcd9e..2533703dada0 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/RoleDocumentAllOfEntitlements1.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RoleDocumentAllOfEntitlements1.md @@ -34,11 +34,11 @@ Name | Type | Description | Notes $RoleDocumentAllOfEntitlements1 = Initialize-PSSailpoint.V3RoleDocumentAllOfEntitlements1 -HasPermissions false ` -Description Cloud engineering ` -Attribute memberOf ` - -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` -Schema group ` -Privileged false ` -Id 2c918084575812550157589064f33b89 ` - -Name CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Name CN=Cloud Engineering,DC=sailpoint,DC=COM ` -SourceSchemaObjectType group ` -Hash c6fab95235584cca98a454a2f51e5683bc77d6a0 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md index 5298209000d6..dc171e3dccfc 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearch.md @@ -41,10 +41,10 @@ $SavedSearch = Initialize-PSSailpoint.V3SavedSearch -Name Disabled accounts ` -Created 2018-06-25T20:22:28.104Z ` -Modified 2018-06-25T20:22:28.104Z ` -Indices [identities] ` - -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` -Query @accounts(disabled:true) ` -Fields [disabled] ` - -OrderBy {identity=[lastName, firstName], role=[name]} ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` -Sort [displayName] ` -Filters null ` -Id 0de46054-fe90-434a-b84e-c6b3359d0c64 ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md index f41b57ea608c..7491b37c7b6d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SavedSearchDetail.md @@ -33,10 +33,10 @@ Name | Type | Description | Notes $SavedSearchDetail = Initialize-PSSailpoint.V3SavedSearchDetail -Created 2018-06-25T20:22:28.104Z ` -Modified 2018-06-25T20:22:28.104Z ` -Indices [identities] ` - -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` -Query @accounts(disabled:true) ` -Fields [disabled] ` - -OrderBy {identity=[lastName, firstName], role=[name]} ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` -Sort [displayName] ` -Filters null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Schema.md b/docs/tools/sdk/powershell/Reference/V3/Models/Schema.md index 56e93e9ca6ae..9a1c99a2c43b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Schema.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Schema.md @@ -41,8 +41,8 @@ $Schema = Initialize-PSSailpoint.V3Schema -Id 2c9180835d191a86015d28455b4a2329 -HierarchyAttribute memberOf ` -IncludePermissions false ` -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` - -Configuration {groupMemberAttribute=member} ` - -Attributes [{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}] ` + -Configuration {groupMemberAttribute=member} ` + -Attributes [{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}] ` -Created 2019-12-24T22:32:58.104Z ` -Modified 2019-12-31T20:22:28.104Z ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Search.md b/docs/tools/sdk/powershell/Reference/V3/Models/Search.md index 85955b705fa2..bf4db1c01292 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Search.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Search.md @@ -41,7 +41,7 @@ $Search = Initialize-PSSailpoint.V3Search -Indices [identities] ` -QueryType null ` -QueryVersion null ` -Query null ` - -QueryDsl {match={name=john.doe}} ` + -QueryDsl {match={name=john.doe}} ` -TextQuery null ` -TypeAheadQuery null ` -IncludeNested true ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SearchAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V3/Models/SearchAttributeConfig.md index 75a49c795f8c..970127ef49e3 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SearchAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SearchAttributeConfig.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $SearchAttributeConfig = Initialize-PSSailpoint.V3SearchAttributeConfig -Name newMailAttribute ` -DisplayName New Mail Attribute ` - -ApplicationAttributes {2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} + -ApplicationAttributes {2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceDeskIntegrationDto.md index 265c917425a5..80261fcca1fc 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceDeskIntegrationDto.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceDeskIntegrationDto.md @@ -45,7 +45,7 @@ $ServiceDeskIntegrationDto = Initialize-PSSailpoint.V3ServiceDeskIntegrationDto -Cluster xyzzy999 ` -ManagedSources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` -ProvisioningConfig null ` - -Attributes {property=value, key=value} ` + -Attributes {property=value, key=value} ` -BeforeProvisioningRule null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceDeskIntegrationTemplateDto.md index 485cca5059c6..8c48341d4b38 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceDeskIntegrationTemplateDto.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceDeskIntegrationTemplateDto.md @@ -33,7 +33,7 @@ $ServiceDeskIntegrationTemplateDto = Initialize-PSSailpoint.V3ServiceDeskIntegra -Created 2015-05-28T14:07:17Z ` -Modified 2015-05-28T14:07:17Z ` -Type Web Service SDIM ` - -Attributes {property=value, key=value} ` + -Attributes {property=value, key=value} ` -ProvisioningConfig null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfiguration.md index 00549b632fa2..2cf5f21a4e4c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfiguration.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfiguration.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes $ServiceProviderConfiguration = Initialize-PSSailpoint.V3ServiceProviderConfiguration -Enabled true ` -BypassIdp true ` -SamlConfigurationValid true ` - -FederationProtocolDetails [{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] + -FederationProtocolDetails [{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md index 7cda0c68d3e9..4ef2cb7370f8 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -50,7 +50,7 @@ $ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailp -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` -MappingAttribute email ` -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` - -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL ` + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL ` -Alias acme-sp ` -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SodPolicy.md b/docs/tools/sdk/powershell/Reference/V3/Models/SodPolicy.md index 717f4875808d..10468073f593 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SodPolicy.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SodPolicy.md @@ -47,7 +47,7 @@ $SodPolicy = Initialize-PSSailpoint.V3SodPolicy -Id 0f11f2a4-7c94-4bf3-a2bd-742 -OwnerRef null ` -ExternalPolicyReference XYZ policy ` -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 ` + -CompensatingControls Have a manager review the transaction decisions for their "out of compliance" employee ` -CorrectionAdvice Based on the role of the employee, managers should remove access that is not required for their job function. ` -State ENFORCED ` -Tags [TAG1, TAG2] ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SodViolationCheckResult.md b/docs/tools/sdk/powershell/Reference/V3/Models/SodViolationCheckResult.md index ea8713b711d4..be303984f4fe 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SodViolationCheckResult.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SodViolationCheckResult.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $SodViolationCheckResult = Initialize-PSSailpoint.V3SodViolationCheckResult -Message null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` -ViolationContexts null ` -ViolatedPolicies null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Source.md b/docs/tools/sdk/powershell/Reference/V3/Models/Source.md index 70f21d7d223c..2b287628ca2c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Source.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Source.md @@ -62,13 +62,13 @@ $Source = Initialize-PSSailpoint.V3Source -Id 2c91808568c529c60168cca6f90c1324 -ManagerCorrelationMapping null ` -ManagerCorrelationRule null ` -BeforeProvisioningRule null ` - -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` - -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` + -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` + -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` -Type OpenLDAP - Direct ` -Connector active-directory ` -ConnectorClass sailpoint.connector.LDAPConnector ` - -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` + -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` -DeleteThreshold 10 ` -Authoritative false ` -ManagementWorkgroup null ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md index 0328c565b955..92919ac01f24 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/SpConfigMessage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SpConfigMessage.md index 886d89dbf3fd..9ede51b9b897 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SpConfigMessage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SpConfigMessage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes ```powershell $SpConfigMessage = Initialize-PSSailpoint.V3SpConfigMessage -Key UNKNOWN_REFERENCE_RESOLVER ` -Text Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity] ` - -Details {details=message details} + -Details {details=message details} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Split.md b/docs/tools/sdk/powershell/Reference/V3/Models/Split.md index 33a156039095..f192a07e2201 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Split.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Split.md @@ -30,7 +30,7 @@ $Split = Initialize-PSSailpoint.V3Split -Delimiter , ` -Index 5 ` -Throws true ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Substring.md b/docs/tools/sdk/powershell/Reference/V3/Models/Substring.md index 6ffebb16f4b2..14f7dc7388d3 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Substring.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Substring.md @@ -32,7 +32,7 @@ $Substring = Initialize-PSSailpoint.V3Substring -VarBegin 1 ` -VarEnd 6 ` -EndOffset 1 ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/TaskResultDetails.md b/docs/tools/sdk/powershell/Reference/V3/Models/TaskResultDetails.md index 307b96691c57..96175c1230dc 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/TaskResultDetails.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/TaskResultDetails.md @@ -47,7 +47,7 @@ $TaskResultDetails = Initialize-PSSailpoint.V3TaskResultDetails -Type MENTOS ` -CompletionStatus Success ` -Messages [] ` -Returns [] ` - -Attributes {org=an-org} ` + -Attributes {org=an-org} ` -Progress Initializing... ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/V3/Models/TestExternalExecuteWorkflow200Response.md index c4dd3b4ed8a8..726d7640f8b5 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/TestExternalExecuteWorkflow200Response.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/TestExternalExecuteWorkflow200Response.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$TestExternalExecuteWorkflow200Response = Initialize-PSSailpoint.V3TestExternalExecuteWorkflow200Response -Payload {test=hello world} +$TestExternalExecuteWorkflow200Response = Initialize-PSSailpoint.V3TestExternalExecuteWorkflow200Response -Payload {test=hello world} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/TestExternalExecuteWorkflowRequest.md index 0cfc17686f0c..0ee3957dc6aa 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/TestExternalExecuteWorkflowRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/TestExternalExecuteWorkflowRequest.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$TestExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V3TestExternalExecuteWorkflowRequest -VarInput {test=hello world} +$TestExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V3TestExternalExecuteWorkflowRequest -VarInput {test=hello world} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/TransformAttributes.md b/docs/tools/sdk/powershell/Reference/V3/Models/TransformAttributes.md index 18e2f0e675a1..e30b541abf63 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/TransformAttributes.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/TransformAttributes.md @@ -67,10 +67,10 @@ $TransformAttributes = Initialize-PSSailpoint.V3TransformAttributes -SourceName -AccountSortAttribute created ` -AccountSortDescending false ` -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` -Values string$variable ` -Expression now+1w ` -PositiveCondition true ` @@ -92,7 +92,7 @@ $TransformAttributes = Initialize-PSSailpoint.V3TransformAttributes -SourceName -Substring admin_ ` -Format alpha2 ` -Padding 0 ` - -Table {-= , "=', ñ=n} ` + -Table {-= , "=', ñ=n} ` -Id Existing Transform ` -Regex [^a-zA-Z] ` -Replacement ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md index cb61a482ae7f..5102243eeb1d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'TransformDefin Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | Transform definition type. | [optional] +**Type** | **String** | The type of the transform definition. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $TransformDefinition = Initialize-PSSailpoint.V3TransformDefinition -Type accountAttribute ` - -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} + -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Trim.md b/docs/tools/sdk/powershell/Reference/V3/Models/Trim.md index c30af623a18e..5be70fea6532 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Trim.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Trim.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Trim = Initialize-PSSailpoint.V3Trim -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Upper.md b/docs/tools/sdk/powershell/Reference/V3/Models/Upper.md index b5b1ef75f4dc..ff3d4c4dbe46 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Upper.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Upper.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $Upper = Initialize-PSSailpoint.V3Upper -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/V3ConnectorDto.md b/docs/tools/sdk/powershell/Reference/V3/Models/V3ConnectorDto.md index d4a2b3c7b887..b3e3075c6fee 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/V3ConnectorDto.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/V3ConnectorDto.md @@ -35,7 +35,7 @@ $V3ConnectorDto = Initialize-PSSailpoint.V3V3ConnectorDto -Name name ` -ClassName sailpoint.connector.OpenConnectorAdapter ` -Features [PROVISIONING, SYNC_PROVISIONING, SEARCH, UNSTRUCTURED_TARGETS] ` -DirectConnect true ` - -ConnectorMetadata {supportedUI=ANGULAR, platform=ccg, shortDesc=connector description} ` + -ConnectorMetadata {supportedUI=ANGULAR, platform=ccg, shortDesc=connector description} ` -Status RELEASED ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkItemForward.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkItemForward.md index f1adda32b9d0..7162fa01fbf0 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkItemForward.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkItemForward.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $WorkItemForward = Initialize-PSSailpoint.V3WorkItemForward -TargetOwnerId 2c9180835d2e5168015d32f890ca1581 ` - -Comment I'm going on vacation. ` + -Comment I'm going on vacation. ` -SendNotifications true ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkItems.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkItems.md index 11217131a539..99e1142de6ca 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkItems.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkItems.md @@ -45,7 +45,7 @@ $WorkItems = Initialize-PSSailpoint.V3WorkItems -Id 2c9180835d2e5168015d32f890c -OwnerName Jason Smith ` -Created 2017-07-11T18:45:37.098Z ` -Modified 2018-06-25T20:22:28.104Z ` - -Description Create account on source 'AD' ` + -Description Create account on source 'AD' ` -State null ` -Type null ` -RemediationItems null ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Workflow.md b/docs/tools/sdk/powershell/Reference/V3/Models/Workflow.md index 4ee960134ac9..127ae0033263 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Workflow.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Workflow.md @@ -36,7 +36,7 @@ Name | Type | Description | Notes ```powershell $Workflow = Initialize-PSSailpoint.V3Workflow -Name Send Email ` -Owner null ` - -Description Send an email to the identity who's attributes changed. ` + -Description Send an email to the identity who's attributes changed. ` -Definition null ` -Enabled false ` -Trigger null ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowBody.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowBody.md index 5682aa1151f8..44cb1512f8c4 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowBody.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowBody.md @@ -29,7 +29,7 @@ Name | Type | Description | Notes ```powershell $WorkflowBody = Initialize-PSSailpoint.V3WorkflowBody -Name Send Email ` -Owner null ` - -Description Send an email to the identity who's attributes changed. ` + -Description Send an email to the identity who's attributes changed. ` -Definition null ` -Enabled false ` -Trigger null diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowDefinition.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowDefinition.md index ffb9aa265f19..3e5825241933 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowDefinition.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowDefinition.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $WorkflowDefinition = Initialize-PSSailpoint.V3WorkflowDefinition -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}} + -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}} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md index b8adc8865773..28b3d0e3c1ab 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryAction.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryAction.md index baa9f9333e42..2dbbf08932bb 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryAction.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryAction.md @@ -44,7 +44,7 @@ $WorkflowLibraryAction = Initialize-PSSailpoint.V3WorkflowLibraryAction -Id sp: -VersionNumber null ` -IsSimulationEnabled null ` -IsDynamicSchema false ` - -OutputSchema {definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} + -OutputSchema {definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryOperator.md index 7ba5f2939169..de66626ca691 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryOperator.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryOperator.md @@ -38,7 +38,7 @@ $WorkflowLibraryOperator = Initialize-PSSailpoint.V3WorkflowLibraryOperator -Id -Deprecated null ` -DeprecatedBy null ` -IsSimulationEnabled null ` - -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryTrigger.md index 7d6b35fce0ba..f6f68c4a830e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryTrigger.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowLibraryTrigger.md @@ -41,7 +41,7 @@ $WorkflowLibraryTrigger = Initialize-PSSailpoint.V3WorkflowLibraryTrigger -Id i -Name Identity Attributes Changed ` -Description One or more identity attributes changed. ` -IsDynamicSchema false ` - -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ` + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ` -FormFields [] ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowTriggerAttributes.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowTriggerAttributes.md index 7abd678c1315..e1d7e61b591c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowTriggerAttributes.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowTriggerAttributes.md @@ -34,7 +34,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell $WorkflowTriggerAttributes = Initialize-PSSailpoint.V3WorkflowTriggerAttributes -Id idn:identity-attributes-changed ` - -VarFilter $.changes[?(@.attribute == 'manager')] ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` -Description Run a search and notify the results ` -AttributeToFilter LifecycleState ` -Name search-and-notify ` diff --git a/static/code-examples/beta/code_examples_overlay.yaml b/static/code-examples/beta/code_examples_overlay.yaml index ce5537cf6d15..b771228d4180 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 -AccountId $AccountId - - # Below is a request that includes all optional parameters - # 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 - } - path: /accounts method: POST xCodeSample: @@ -1084,8 +1061,8 @@ $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 = "identityId eq "2c9180858082150f0180893dbaf44201"" # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (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, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # Accounts List @@ -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 -AccountId $AccountId + + # Below is a request that includes all optional parameters + # 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 + } - path: /discovered-applications/{id} method: GET xCodeSample: @@ -6034,7 +6034,7 @@ } "@ - # Create Identity Profile + # Create an Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -6052,9 +6052,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#delete-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. - # Delete Identity Profile + # Delete an Identity Profile try { Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -6135,9 +6135,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#get-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID - # Get Identity Profile + # Gets a single Identity Profile try { Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -6239,10 +6239,10 @@ $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 8c190e6787aa4ed9a90bd9d5344523fb" # 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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + $Filters = "id eq 8c190e6787aa4ed9a90bd9d5344523fb" # 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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) $Sorters = "name,-priority" # 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, priority, created, modified, owner.id, owner.name** (optional) - # List Identity Profiles + # Identity Profiles List try { Get-BetaIdentityProfiles @@ -6326,7 +6326,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#update-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -6334,7 +6334,7 @@ }"@ - # Update Identity Profile + # Update the Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6536,6 +6536,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 -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-BetaManagedClientStatus -Id $Id -Type $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 -Id $Id -BetaManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -Id $Id -BetaManagedClientStatus $Result + } 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 -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaClientLogConfiguration -Id $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 -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaManagedCluster -Id $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 -Offset $Offset -Limit $Limit -Count $Count -Filters $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 -Id $Id -BetaClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -Id $Id -BetaClientLogConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -6862,214 +7018,58 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status - method: GET +- path: /multihosts + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-multi-host-integration source: | - $Id = "aClientId" # String | ID of the Managed Client Status to get - $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get + $MultiHostIntegrationsCreate = @" + { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } + "@ - # Specified Managed Client Status. + # Create Multi-Host Integration try { - Get-BetaManagedClientStatus -Id $Id -Type $Type + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate + New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result # Below is a request that includes all optional parameters - # Get-BetaManagedClientStatus -Id $Id -Type $Type + # New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status +- path: /multihosts/{multihostId} 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 -Id $Id -BetaManagedClientStatus $Result - - # Below is a request that includes all optional parameters - # Update-BetaManagedClientStatus -Id $Id -BetaManagedClientStatus $Result - } 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 -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaClientLogConfiguration -Id $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 -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaManagedCluster -Id $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 -Offset $Offset -Limit $Limit -Count $Count -Filters $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 -Id $Id -BetaClientLogConfiguration $Result - - # Below is a request that includes all optional parameters - # Send-BetaClientLogConfiguration -Id $Id -BetaClientLogConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /multihosts - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-multi-host-integration - source: | - $MultiHostIntegrationsCreate = @" - { - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "connector" : "multihost-microsoft-sql-server", - "connectorAttributes" : { - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "created" : "2022-02-08T14:50:03.827Z", - "name" : "My Multi-Host Integration", - "description" : "This is the Multi-Host Integration.", - "modified" : "2024-01-23T18:08:50.897Z" - } - "@ - - # Create Multi-Host Integration - - try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate - New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result - - # Below is a request that includes all optional parameters - # New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" - Write-Host $_.ErrorDetails - } -- path: /multihosts/{multihostId} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-sources-within-multi-host + label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#create-sources-within-multi-host source: | $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. $MultiHostIntegrationsCreateSources = @"{ @@ -7918,20 +7918,20 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-sources source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. + $NonEmployeeCount = $false # Boolean | The flag to determine whether return a non-employee count associate with 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) - $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) - $NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # 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, created, sourceId** (optional) # List Non-Employee Sources try { - Get-BetaNonEmployeeSources + Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $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 @@ -9796,1430 +9796,1248 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /accounts/search-attribute-config method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#create-sim-integration + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config source: | - $SimIntegrationDetails = @" + $SearchAttributeConfig = @" { - "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" + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" } } "@ - # Create new SIM integration + # Create Extended Search Attributes try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-BetaSIMIntegration -BetaSimIntegrationDetails $Result + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result # Below is a request that includes all optional parameters - # New-BetaSIMIntegration -BetaSimIntegrationDetails $Result + # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} +- path: /accounts/search-attribute-config/{name} method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#delete-sim-integration + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config source: | - $Id = "12345" # String | The id of the integration to delete. + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - # Delete a SIM integration + # Delete Extended Search Attribute try { - Remove-BetaSIMIntegration -Id $Id + Remove-BetaSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Remove-BetaSIMIntegration -Id $Id + # Remove-BetaSearchAttributeConfig -Name $Name } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} +- path: /accounts/search-attribute-config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config source: | - $Id = "12345" # String | The id of the integration. - # Get a SIM integration details. + # List Extended Search Attributes try { - Get-BetaSIMIntegration -Id $Id + Get-BetaSearchAttributeConfig # Below is a request that includes all optional parameters - # Get-BetaSIMIntegration -Id $Id + # Get-BetaSearchAttributeConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /accounts/search-attribute-config/{name} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integrations + 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. - # List the existing SIM integrations. + # Get Extended Search Attribute try { - Get-BetaSIMIntegrations + Get-BetaSingleSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Get-BetaSIMIntegrations + # Get-BetaSingleSearchAttributeConfig -Name $Name } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $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-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} +- path: /accounts/search-attribute-config/{name} method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-sim-attributes + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config source: | - $Id = "12345" # String | SIM integration id - $JsonPatch = @" - "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" - "@ - - # Patch a SIM attribute. + $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $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 + # Update Extended Search Attribute try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result + # Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /sod-policies +- path: /segments method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#create-sod-policy + label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment source: | - $SodPolicy = @" + $Segment = @" { - "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", + "owner" : { + "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" + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" } }, - "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", + "name" : "segment-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" + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" } "@ - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-BetaSodPolicy -BetaSodPolicy $Result - - # Below is a request that includes all optional parameters - # New-BetaSodPolicy -BetaSodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # 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. (optional) (default to $true) - - # Delete SOD policy by ID + # Create Segment try { - Remove-BetaSodPolicy -Id $Id + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-BetaSegment -BetaSegment $Result # Below is a request that includes all optional parameters - # Remove-BetaSodPolicy -Id $Id -Logical $Logical + # New-BetaSegment -BetaSegment $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule +- path: /segments/{id} method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy-schedule + label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - # Delete SOD policy schedule + # Delete Segment by ID try { - Remove-BetaSodPolicySchedule -Id $Id + Remove-BetaSegment -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaSodPolicySchedule -Id $Id + # Remove-BetaSegment -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download/{fileName} +- path: /segments/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-custom-violation-report + label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - # Download custom violation report + # Get Segment by ID try { - Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + Get-BetaSegment -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + # Get-BetaSegment -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download +- path: /segments method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-default-violation-report + label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $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) - # Download violation report + # List Segments try { - Get-BetaDefaultViolationReport -ReportResultId $ReportResultId + Get-BetaSegments # Below is a request that includes all optional parameters - # Get-BetaDefaultViolationReport -ReportResultId $ReportResultId + # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" Write-Host $_.ErrorDetails } -- path: /sod-violation-report - method: GET +- path: /segments/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-all-report-run-status + 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}}]}}}]"@ - # Get multi-report run task status + + # Update Segment try { - Get-BetaSodAllReportRunStatus + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSegment -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Get-BetaSodAllReportRunStatus + # Update-BetaSegment -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: GET +- path: /service-desk-integrations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + $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" : "" + } + "@ - # Get SOD policy by ID + # Create new Service Desk integration try { - Get-BetaSodPolicy -Id $Id + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Get-BetaSodPolicy -Id $Id + # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule - method: GET +- path: /service-desk-integrations/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy-schedule + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + $Id = "anId" # String | ID of Service Desk integration to delete - # Get SOD policy schedule + # Delete a Service Desk integration try { - Get-BetaSodPolicySchedule -Id $Id + Remove-BetaServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSodPolicySchedule -Id $Id + # Remove-BetaServiceDeskIntegration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/sod-violation-report-status/{reportResultId} +- path: /service-desk-integrations/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-run-status + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + $Id = "anId" # String | ID of the Service Desk integration to get - # Get violation report run status + # Get a Service Desk integration try { - Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId + Get-BetaServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId + # Get-BetaServiceDeskIntegration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/violation-report +- path: /service-desk-integrations method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-status + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + $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) - # Get SOD violation report status + # List existing Service Desk integrations try { - Get-BetaSodViolationReportStatus -Id $Id + Get-BetaServiceDeskIntegrationList # Below is a request that includes all optional parameters - # Get-BetaSodViolationReportStatus -Id $Id + # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" Write-Host $_.ErrorDetails } -- path: /sod-policies +- path: /service-desk-integrations/templates/{scriptName} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#list-sod-policies + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template 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) + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - # List SOD policies + # Service Desk integration template by scriptName try { - Get-BetaSodPolicies + Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName # Below is a request that includes all optional parameters - # Get-BetaSodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: PATCH +- path: /service-desk-integrations/types + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#patch-sod-policy + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. - $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - $RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ - - # Patch a SOD policy + # List Service Desk integration types try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSodPolicy -Id $Id -RequestBody $Result + Get-BetaServiceDeskIntegrationTypes # Below is a request that includes all optional parameters - # Update-BetaSodPolicy -Id $Id -RequestBody $Result + # Get-BetaServiceDeskIntegrationTypes } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule - method: PUT +- path: /service-desk-integrations/status-check-configuration + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-policy-schedule + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # 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" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false + + # 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 = @" + "@ - # Update SOD Policy schedule + # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result # Below is a request that includes all optional parameters - # Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result + # Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} +- path: /service-desk-integrations/{id} method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-sod-policy + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" { - "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" : "", + "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" } }, - "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" - } + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" }, - "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" + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" } "@ - # Update SOD policy by ID + # Update a Service Desk integration try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result + # Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/run - method: POST +- path: /service-desk-integrations/status-check-configuration + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-all-policies-for-org + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details source: | - $MultiPolicyRequest = @" + $QueuedCheckConfigDetails = @" { - "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" } "@ - # Runs all policies for org + # Update the time check configuration try { - Start-BetaSodAllPoliciesForOrg + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result # Below is a request that includes all optional parameters - # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $Result + # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/violation-report/run +- path: /sim-integrations method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-policy + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#create-sim-integration source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. + $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" + } + } + "@ - # Runs SOD policy violation report + # Create new SIM integration try { - Start-BetaSodPolicy -Id $Id + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-BetaSIMIntegration -BetaSimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Start-BetaSodPolicy -Id $Id + # New-BetaSIMIntegration -BetaSimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" Write-Host $_.ErrorDetails } -- path: /sod-violations/predict - method: POST +- path: /sim-integrations/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sod-violations#start-predict-sod-violations + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#delete-sim-integration 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" - } ] - } - "@ + $Id = "12345" # String | The id of the integration to delete. - # Predict SOD violations for identity. + # Delete a SIM integration try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result + Remove-BetaSIMIntegration -Id $Id # Below is a request that includes all optional parameters - # Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result + # Remove-BetaSIMIntegration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" Write-Host $_.ErrorDetails } -- path: /sp-config/export - method: POST +- path: /sim-integrations/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integration source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ + $Id = "12345" # String | The id of the integration. - # Initiates configuration objects export job + # Get a SIM integration details. try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-BetaSpConfig -BetaExportPayload $Result + Get-BetaSIMIntegration -Id $Id # Below is a request that includes all optional parameters - # Export-BetaSpConfig -BetaExportPayload $Result + # Get-BetaSIMIntegration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" Write-Host $_.ErrorDetails } -- path: /sp-config/export/{id}/download +- path: /sim-integrations method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integrations source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - # Download export job result. + # List the existing SIM integrations. try { - Get-BetaSpConfigExport -Id $Id + Get-BetaSIMIntegrations # Below is a request that includes all optional parameters - # Get-BetaSpConfigExport -Id $Id + # Get-BetaSIMIntegrations } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" Write-Host $_.ErrorDetails } -- path: /sp-config/export/{id} - method: GET +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-before-provisioning-rule source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ - # Get export job status + # Patch a SIM beforeProvisioningRule attribute. try { - Get-BetaSpConfigExportStatus -Id $Id + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result # Below is a request that includes all optional parameters - # Get-BetaSpConfigExportStatus -Id $Id + # Update-BetaBeforeProvisioningRule -Id $Id -BetaJsonPatch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" Write-Host $_.ErrorDetails } -- path: /sp-config/import/{id}/download - method: GET +- path: /sim-integrations/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#patch-sim-attributes source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ - # Download import job result + # Patch a SIM attribute. try { - Get-BetaSpConfigImport -Id $Id + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result # Below is a request that includes all optional parameters - # Get-BetaSpConfigImport -Id $Id + # Update-BetaSIMAttributes -Id $Id -BetaJsonPatch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" Write-Host $_.ErrorDetails } -- path: /sp-config/import/{id} - method: GET +- path: /sim-integrations/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status + label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#put-sim-integration source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status + $Id = "12345" # String | The id of the integration. + $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 { - Get-BetaSpConfigImportStatus -Id $Id + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Get-BetaSpConfigImportStatus -Id $Id + # Send-BetaSIMIntegration -Id $Id -BetaSimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" Write-Host $_.ErrorDetails } -- path: /sp-config/import +- path: /sod-policies method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#create-sod-policy 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 = @" + $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" + } "@ - # Initiates configuration objects import job + # Create SOD policy try { - Import-BetaSpConfig -Data $Data + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-BetaSodPolicy -BetaSodPolicy $Result # Below is a request that includes all optional parameters - # Import-BetaSpConfig -Data $Data -Preview $Preview -BetaOptions $Options + # New-BetaSodPolicy -BetaSodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" Write-Host $_.ErrorDetails } -- path: /sp-config/config-objects - method: GET +- path: /sod-policies/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # 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. (optional) (default to $true) - # Get config object details + # Delete SOD policy by ID try { - Get-BetaSpConfigObjects + Remove-BetaSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSpConfigObjects + # Remove-BetaSodPolicy -Id $Id -Logical $Logical } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config - method: POST +- path: /sod-policies/{id}/schedule + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#delete-sod-policy-schedule source: | - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - # Create Extended Search Attributes + # Delete SOD policy schedule try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result + Remove-BetaSodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $Result + # Remove-BetaSodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} - method: DELETE +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-custom-violation-report source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. - # Delete Extended Search Attribute + # Download custom violation report try { - Remove-BetaSearchAttributeConfig -Name $Name + Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName # Below is a request that includes all optional parameters - # Remove-BetaSearchAttributeConfig -Name $Name + # Get-BetaCustomViolationReport -ReportResultId $ReportResultId -FileName $FileName } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config +- path: /sod-violation-report/{reportResultId}/download method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-default-violation-report source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - # List Extended Search Attributes + # Download violation report try { - Get-BetaSearchAttributeConfig + Get-BetaDefaultViolationReport -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Get-BetaSearchAttributeConfig + # Get-BetaDefaultViolationReport -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} +- path: /sod-violation-report method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-all-report-run-status source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - # Get Extended Search Attribute + # Get multi-report run task status try { - Get-BetaSingleSearchAttributeConfig -Name $Name + Get-BetaSodAllReportRunStatus # Below is a request that includes all optional parameters - # Get-BetaSingleSearchAttributeConfig -Name $Name + # Get-BetaSodAllReportRunStatus } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} - method: PATCH +- path: /sod-policies/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy source: | - $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - # Update Extended Search Attribute + # Get SOD policy by ID try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result + Get-BetaSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Update-BetaSearchAttributeConfig -Name $Name -BetaJsonPatchOperation $Result + # Get-BetaSodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" Write-Host $_.ErrorDetails } -- path: /segments - method: POST +- path: /sod-policies/{id}/schedule + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-policy-schedule 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" - } - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - # Create Segment + # Get SOD policy schedule try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-BetaSegment -BetaSegment $Result + Get-BetaSodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # New-BetaSegment -BetaSegment $Result + # Get-BetaSodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" Write-Host $_.ErrorDetails } -- path: /segments/{id} - method: DELETE - xCodeSample: +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-run-status source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - # Delete Segment by ID + # Get violation report run status try { - Remove-BetaSegment -Id $Id + Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Remove-BetaSegment -Id $Id + # Get-BetaSodViolationReportRunStatus -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" Write-Host $_.ErrorDetails } -- path: /segments/{id} +- path: /sod-policies/{id}/violation-report method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#get-sod-violation-report-status source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - # Get Segment by ID + # Get SOD violation report status try { - Get-BetaSegment -Id $Id + Get-BetaSodViolationReportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-BetaSegment -Id $Id + # Get-BetaSodViolationReportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" Write-Host $_.ErrorDetails } -- path: /segments +- path: /sod-policies method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments + label: SDK_tools/sdk/powershell/beta/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 Segments + # List SOD policies try { - Get-BetaSegments + Get-BetaSodPolicies # Below is a request that includes all optional parameters - # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count + # Get-BetaSodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" Write-Host $_.ErrorDetails } -- path: /segments/{id} +- path: /sod-policies/{id} method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#patch-sod-policy 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}}]}}}]"@ + $Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. + $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + $RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ - # Update Segment + # Patch a SOD policy try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSegment -Id $Id -RequestBody $Result + Update-BetaSodPolicy -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Update-BetaSegment -Id $Id -RequestBody $Result + # Update-BetaSodPolicy -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations - method: POST +- path: /sod-policies/{id}/schedule + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-policy-schedule source: | - $ServiceDeskIntegrationDto = @" + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" { - "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" + "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" }, - "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 $Result - } 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 -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaServiceDeskIntegration -Id $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 -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegration -Id $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 -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 - } -- 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 -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTemplate -ScriptName $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 + "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" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false } -- 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 + # Update SOD Policy schedule try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -Id $Id -BetaPatchServiceDeskIntegrationRequest $Result + # Send-BetaPolicySchedule -Id $Id -BetaSodPolicySchedule $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} +- path: /sod-policies/{id} method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#put-sod-policy source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" { - "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" + "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" + } ] } }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" + "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 a Service Desk integration + # Update SOD policy by ID try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result # Below is a request that includes all optional parameters - # Send-BetaServiceDeskIntegration -Id $Id -BetaServiceDeskIntegrationDto $Result + # Send-BetaSodPolicy -Id $Id -BetaSodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/status-check-configuration - method: PUT +- path: /sod-violation-report/run + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-all-policies-for-org source: | - $QueuedCheckConfigDetails = @" + $MultiPolicyRequest = @" { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] } "@ - # Update the time check configuration + # Runs all policies for org try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result + Start-BetaSodAllPoliciesForOrg # Below is a request that includes all optional parameters - # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $Result + # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sod-policies/{id}/violation-report/run + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/beta/methods/sod-policies#start-sod-policy source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. - # Finds status of source usage + # Runs SOD policy violation report try { - Get-BetaStatusBySourceId -SourceId $SourceId + Start-BetaSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Get-BetaStatusBySourceId -SourceId $SourceId + # Start-BetaSodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries - method: GET +- path: /sod-violations/predict + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/powershell/beta/methods/sod-violations#start-predict-sod-violations 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) + $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" + } ] + } + "@ - # Returns source usage insights + # Predict SOD violations for identity. try { - Get-BetaUsagesBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -12539,6 +12357,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 -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaStatusBySourceId -SourceId $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 -SourceId $SourceId + + # Below is a request that includes all optional parameters + # 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 + } +- 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 $Result + } 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 -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExport -Id $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 -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExportStatus -Id $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 -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImport -Id $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 -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImportStatus -Id $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 -Data $Data + + # Below is a request that includes all optional parameters + # Import-BetaSpConfig -Data $Data -Preview $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: @@ -13724,878 +13724,878 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/approve/{approvalItemId} +- path: /workflow-executions/{id}/cancel method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-item + label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - # Approve an Approval Item + # Cancel Workflow Execution by ID try { - Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Suspend-BetaWorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Suspend-BetaWorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-approve/{id} +- path: /workflows method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-items-in-bulk + label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $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')]}}} + "@ - # Bulk approve Approval Items + # Create Workflow try { - Approve-BetaApprovalItemsInBulk -Id $Id + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-BetaWorkflow -BetaCreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # Approve-BetaApprovalItemsInBulk -Id $Id + # New-BetaWorkflow -BetaCreateWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id} - method: POST +- path: /workflows/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item + label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - # Complete a Work Item + # Delete Workflow By Id try { - Complete-BetaWorkItem -Id $Id + Remove-BetaWorkflow -Id $Id # Below is a request that includes all optional parameters - # Complete-BetaWorkItem -Id $Id + # Remove-BetaWorkflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/forward - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#forward-work-item - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $WorkItemForward = @" - { - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true - } - "@ +- 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 - # Forward a Work Item + # Get Workflow By Id try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result + Get-BetaWorkflow -Id $Id # Below is a request that includes all optional parameters - # Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result + # Get-BetaWorkflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /work-items/completed +- path: /workflow-executions/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-completed-work-items + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution source: | - $OwnerId = "MyOwnerId" # 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) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - # Completed Work Items + # Get Workflow Execution try { - Get-BetaCompletedWorkItems + Get-BetaWorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + # Get-BetaWorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" Write-Host $_.ErrorDetails } -- path: /work-items/completed/count +- path: /workflow-executions/{id}/history method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-completed-work-items + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - # Count Completed Work Items + # Get Workflow Execution History try { - Get-BetaCountCompletedWorkItems + Get-BetaWorkflowExecutionHistory -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId + # Get-BetaWorkflowExecutionHistory -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" Write-Host $_.ErrorDetails } -- path: /work-items/count +- path: /workflows/{id}/executions method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-work-items + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + $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) - # Count Work Items + # List Workflow Executions try { - Get-BetaCountWorkItems + Get-BetaWorkflowExecutions -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCountWorkItems -OwnerId $OwnerId + # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" Write-Host $_.ErrorDetails } -- path: /work-items/{id} +- path: /workflow-library method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library source: | - $Id = "MyId" # String | ID of the work item. - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (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) - # Get a Work Item + # List Complete Workflow Library try { - Get-BetaWorkItem -Id $Id + Get-BetaCompleteWorkflowLibrary # Below is a request that includes all optional parameters - # Get-BetaWorkItem -Id $Id -OwnerId $OwnerId + # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" Write-Host $_.ErrorDetails } -- path: /work-items/summary +- path: /workflow-library/actions method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-items-summary + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions source: | - $OwnerId = "MyOwnerId" # String | ID of the work item owner. (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) + $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) - # Work Items Summary + # List Workflow Library Actions try { - Get-BetaWorkItemsSummary + Get-BetaWorkflowLibraryActions # Below is a request that includes all optional parameters - # Get-BetaWorkItemsSummary -OwnerId $OwnerId + # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" Write-Host $_.ErrorDetails } -- path: /work-items +- path: /workflow-library/operators method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#list-work-items + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators 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 = "MyOwnerId" # String | ID of the work item owner. (optional) - # List Work Items + # List Workflow Library Operators try { - Get-BetaWorkItems + Get-BetaWorkflowLibraryOperators # Below is a request that includes all optional parameters - # Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + # Get-BetaWorkflowLibraryOperators } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST +- path: /workflow-library/triggers + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-item + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + $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) - # Reject an Approval Item + # List Workflow Library Triggers try { - Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Get-BetaWorkflowLibraryTriggers # Below is a request that includes all optional parameters - # Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-reject/{id} - method: POST +- path: /workflows + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-items-in-bulk + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Bulk reject Approval Items + # List Workflows try { - Deny-BetaApprovalItemsInBulk -Id $Id + Get-BetaWorkflows # Below is a request that includes all optional parameters - # Deny-BetaApprovalItemsInBulk -Id $Id + # Get-BetaWorkflows } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/submit-account-selection - method: POST +- path: /workflows/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-items#submit-account-selection + label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Submit Account Selections + + # Patch Workflow try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-BetaAccountSelection -Id $Id -RequestBody $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result # Below is a request that includes all optional parameters - # Submit-BetaAccountSelection -Id $Id -RequestBody $Result + # Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations +- path: /workflows/execute/external/{id} method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#create-reassignment-configuration + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow source: | - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $PostExternalExecuteWorkflowRequest = @" + "@ - # Create a Reassignment Configuration + # Execute Workflow via External Trigger try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result + Submit-BetaExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result + # Submit-BetaExternalExecuteWorkflow -Id $Id -BetaPostExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId}/{configType} - method: DELETE +- path: /workflows/{id}/external/oauth-clients + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#delete-reassignment-configuration + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Delete Reassignment Configuration + # Generate External Trigger OAuth Client try { - Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + Submit-BetaWorkflowExternalTrigger -Id $Id # Below is a request that includes all optional parameters - # Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + # Submit-BetaWorkflowExternalTrigger -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId}/evaluate/{configType} - method: GET +- path: /workflows/execute/external/{id}/test + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-evaluate-reassignment-configuration + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type - $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" - $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + "@ - # Evaluate Reassignment Configuration + # Test Workflow via External Trigger try { - Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType + Test-BetaExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters + # Test-BetaExternalExecuteWorkflow -Id $Id -BetaTestExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/types - method: GET +- path: /workflows/{id}/test + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-config-types + 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}]}} + "@ - # List Reassignment Config Types + # Test Workflow By Id try { - Get-BetaReassignmentConfigTypes + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfigTypes + # Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId} - method: GET +- path: /workflows/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-configuration + label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + $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 + } + "@ - # Get Reassignment Configuration + # Update Workflow try { - Get-BetaReassignmentConfiguration -IdentityId $IdentityId + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfiguration -IdentityId $IdentityId + # Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/tenant-config - method: GET +- path: /work-items/{id}/approve/{approvalItemId} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-tenant-config-configuration + label: SDK_tools/sdk/powershell/beta/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. - # Get Tenant-wide Reassignment Configuration settings + # Approve an Approval Item try { - Get-BetaTenantConfigConfiguration + Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Get-BetaTenantConfigConfiguration + # Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations - method: GET +- path: /work-items/bulk-approve/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#list-reassignment-configurations + label: SDK_tools/sdk/powershell/beta/methods/work-items#approve-approval-items-in-bulk source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # List Reassignment Configurations + # Bulk approve Approval Items try { - Get-BetaReassignmentConfigurations + Approve-BetaApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfigurations + # Approve-BetaApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId} - method: PUT +- path: /work-items/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-reassignment-config + label: SDK_tools/sdk/powershell/beta/methods/work-items#complete-work-item source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Update Reassignment Configuration + # Complete a Work Item try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result + Complete-BetaWorkItem -Id $Id # Below is a request that includes all optional parameters - # Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result + # Complete-BetaWorkItem -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/tenant-config - method: PUT +- path: /work-items/{id}/forward + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-tenant-configuration + label: SDK_tools/sdk/powershell/beta/methods/work-items#forward-work-item source: | - $TenantConfigurationRequest = @" + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" { - "configDetails" : { - "disabled" : true - } + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true } "@ - # Update Tenant-wide Reassignment Configuration settings + # Forward a Work Item try { - $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result # Below is a request that includes all optional parameters - # Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result + # Invoke-BetaForwardWorkItem -Id $Id -BetaWorkItemForward $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST +- path: /work-items/completed + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-completed-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + $OwnerId = "MyOwnerId" # 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) - # Cancel Workflow Execution by ID + # Completed Work Items try { - Suspend-BetaWorkflowExecution -Id $Id + Get-BetaCompletedWorkItems # Below is a request that includes all optional parameters - # Suspend-BetaWorkflowExecution -Id $Id + # Get-BetaCompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflows - method: POST +- path: /work-items/completed/count + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-completed-work-items 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')]}}} - "@ + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - # Create Workflow + # Count Completed Work Items try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-BetaWorkflow -BetaCreateWorkflowRequest $Result + Get-BetaCountCompletedWorkItems # Below is a request that includes all optional parameters - # New-BetaWorkflow -BetaCreateWorkflowRequest $Result + # Get-BetaCountCompletedWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: DELETE +- path: /work-items/count + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-count-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - # Delete Workflow By Id + # Count Work Items try { - Remove-BetaWorkflow -Id $Id + Get-BetaCountWorkItems # Below is a request that includes all optional parameters - # Remove-BetaWorkflow -Id $Id + # Get-BetaCountWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" Write-Host $_.ErrorDetails } -- path: /workflows/{id} +- path: /work-items/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $Id = "MyId" # String | ID of the work item. + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - # Get Workflow By Id + # Get a Work Item try { - Get-BetaWorkflow -Id $Id + Get-BetaWorkItem -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkflow -Id $Id + # Get-BetaWorkItem -Id $Id -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id} +- path: /work-items/summary method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution + label: SDK_tools/sdk/powershell/beta/methods/work-items#get-work-items-summary source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - # Get Workflow Execution + # Work Items Summary try { - Get-BetaWorkflowExecution -Id $Id + Get-BetaWorkItemsSummary # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecution -Id $Id + # Get-BetaWorkItemsSummary -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/history +- path: /work-items method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history + label: SDK_tools/sdk/powershell/beta/methods/work-items#list-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + $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 = "MyOwnerId" # String | ID of the work item owner. (optional) - # Get Workflow Execution History + # List Work Items try { - Get-BetaWorkflowExecutionHistory -Id $Id + Get-BetaWorkItems # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutionHistory -Id $Id + # Get-BetaWorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/executions - method: GET +- path: /work-items/{id}/reject/{approvalItemId} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions + label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-item 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # List Workflow Executions + # Reject an Approval Item try { - Get-BetaWorkflowExecutions -Id $Id + Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + # Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" Write-Host $_.ErrorDetails } -- path: /workflow-library - method: GET +- path: /work-items/bulk-reject/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library + label: SDK_tools/sdk/powershell/beta/methods/work-items#reject-approval-items-in-bulk 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # List Complete Workflow Library + # Bulk reject Approval Items try { - Get-BetaCompleteWorkflowLibrary + Deny-BetaApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset + # Deny-BetaApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /workflow-library/actions - method: GET +- path: /work-items/{id}/submit-account-selection + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions + label: SDK_tools/sdk/powershell/beta/methods/work-items#submit-account-selection 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - # List Workflow Library Actions + # Submit Account Selections try { - Get-BetaWorkflowLibraryActions + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-BetaAccountSelection -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + # Submit-BetaAccountSelection -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" Write-Host $_.ErrorDetails } -- path: /workflow-library/operators - method: GET +- path: /reassignment-configurations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#create-reassignment-configuration source: | + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ - # List Workflow Library Operators + # Create a Reassignment Configuration try { - Get-BetaWorkflowLibraryOperators + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryOperators + # New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-library/triggers - method: GET +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#delete-reassignment-configuration 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) + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | - # List Workflow Library Triggers + # Delete Reassignment Configuration try { - Get-BetaWorkflowLibraryTriggers + Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + # Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows +- path: /reassignment-configurations/{identityId}/evaluate/{configType} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-evaluate-reassignment-configuration source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - # List Workflows + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration try { - Get-BetaWorkflows + Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType # Below is a request that includes all optional parameters - # Get-BetaWorkflows + # Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -ExclusionFilters $ExclusionFilters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: PATCH +- path: /reassignment-configurations/types + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-config-types source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - # Patch Workflow + # List Reassignment Config Types try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result + Get-BetaReassignmentConfigTypes # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -BetaJsonPatchOperation $Result + # Get-BetaReassignmentConfigTypes } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id} - method: POST +- path: /reassignment-configurations/{identityId} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-configuration source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $PostExternalExecuteWorkflowRequest = @" - - "@ + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id - # Execute Workflow via External Trigger + # Get Reassignment Configuration try { - Submit-BetaExternalExecuteWorkflow -Id $Id + Get-BetaReassignmentConfiguration -IdentityId $IdentityId # Below is a request that includes all optional parameters - # Submit-BetaExternalExecuteWorkflow -Id $Id -BetaPostExternalExecuteWorkflowRequest $Result + # Get-BetaReassignmentConfiguration -IdentityId $IdentityId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/external/oauth-clients - method: POST +- path: /reassignment-configurations/tenant-config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-tenant-config-configuration source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Generate External Trigger OAuth Client + # Get Tenant-wide Reassignment Configuration settings try { - Submit-BetaWorkflowExternalTrigger -Id $Id + Get-BetaTenantConfigConfiguration # Below is a request that includes all optional parameters - # Submit-BetaWorkflowExternalTrigger -Id $Id + # Get-BetaTenantConfigConfiguration } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id}/test - method: POST +- path: /reassignment-configurations + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#list-reassignment-configurations source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - # Test Workflow via External Trigger + # List Reassignment Configurations try { - Test-BetaExternalExecuteWorkflow -Id $Id + Get-BetaReassignmentConfigurations # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -Id $Id -BetaTestExternalExecuteWorkflowRequest $Result + # Get-BetaReassignmentConfigurations } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/test - method: POST +- path: /reassignment-configurations/{identityId} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-reassignment-config 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}]}} + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } "@ - # Test Workflow By Id + # Update Reassignment Configuration try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Test-BetaWorkflow -Id $Id -BetaTestWorkflowRequest $Result + # Send-BetaReassignmentConfig -IdentityId $IdentityId -BetaConfigurationItemRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" Write-Host $_.ErrorDetails } -- path: /workflows/{id} +- path: /reassignment-configurations/tenant-config method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow + label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#put-tenant-configuration source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" + $TenantConfigurationRequest = @" { - "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 + "configDetails" : { + "disabled" : true + } } "@ - # Update Workflow + # Update Tenant-wide Reassignment Configuration settings try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -BetaWorkflowBody $Result + # Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" Write-Host $_.ErrorDetails } diff --git a/static/code-examples/v2024/code_examples_overlay.yaml b/static/code-examples/v2024/code_examples_overlay.yaml index b4f21f0a5470..576d4fd0d577 100644 --- a/static/code-examples/v2024/code_examples_overlay.yaml +++ b/static/code-examples/v2024/code_examples_overlay.yaml @@ -532,14 +532,15 @@ $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. $Type = "ENTITLEMENT" # String | Requested access item's type. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Return access request identity metrics try { - Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type + # 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 @@ -908,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 -AccountId $AccountId - - # Below is a request that includes all optional parameters - # 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 - } - path: /accounts method: POST xCodeSample: @@ -1194,8 +1172,8 @@ $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) $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (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, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # Accounts List @@ -1308,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 -AccountId $AccountId + + # Below is a request that includes all optional parameters + # 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 + } - path: /discovered-applications method: GET xCodeSample: @@ -2848,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 -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # 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 - } -- 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 -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentityDecisionSummary -Id $Id -Filters $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 -Id $Id - - # Below is a request that includes all optional parameters - # 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 - } -- 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 -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3215,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 -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # 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 + } +- 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 -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -Id $Id -Filters $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 -Id $Id + + # Below is a request that includes all optional parameters + # 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 + } +- 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 -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /configuration-hub/deploys method: POST xCodeSample: @@ -5850,25 +5851,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations" Write-Host $_.ErrorDetails } -- path: /ai-access-request-recommendations/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get Access Request Recommendations config - - try { - Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig" - Write-Host $_.ErrorDetails - } - path: /ai-access-request-recommendations/ignored-items method: GET xCodeSample: @@ -5941,36 +5923,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems" Write-Host $_.ErrorDetails } -- path: /ai-access-request-recommendations/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $AccessRequestRecommendationConfigDto = @" - { - "scoreThreshold" : 0.5, - "startDateAttribute" : "startDate", - "restrictionAttribute" : "location", - "moverAttribute" : "isMover", - "joinerAttribute" : "isJoiner", - "useRestrictionAttribute" : true - } - "@ - - # Update Access Request Recommendations config - - try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto - Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationConfigDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig" - Write-Host $_.ErrorDetails - } - path: /common-access method: POST xCodeSample: @@ -7795,7 +7747,7 @@ } "@ - # Create Identity Profile + # Create an Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -7813,9 +7765,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#delete-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. - # Delete Identity Profile + # Delete an Identity Profile try { Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -7896,9 +7848,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#get-identity-profile source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. - # Get Identity Profile + # Get single Identity Profile try { Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -8000,10 +7952,10 @@ $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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + $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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (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, priority, created, modified, owner.id, owner.name** (optional) - # List Identity Profiles + # Identity Profiles List try { Get-V2024IdentityProfiles @@ -8087,7 +8039,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#update-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -8095,7 +8047,7 @@ }"@ - # Update Identity Profile + # Update the Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8267,789 +8219,603 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: GET +- path: /managed-clients + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#create-managed-client source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ - # Configuration of Duo MFA method + # Create Managed Client try { - Get-V2024MFADuoConfig + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-V2024ManagedClient -V2024ManagedClientRequest $Result # Below is a request that includes all optional parameters - # Get-V2024MFADuoConfig + # New-V2024ManagedClient -V2024ManagedClientRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/kba/config - method: GET +- path: /managed-clients/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#delete-managed-client 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) + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Configuration of KBA MFA method + # Delete Managed Client try { - Get-V2024MFAKbaConfig + Remove-V2024ManagedClient -Id $Id # Below is a request that includes all optional parameters - # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages + # Remove-V2024ManagedClient -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/okta-verify/config +- path: /managed-clients/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Configuration of Okta MFA method + # Get Managed Client try { - Get-V2024MFAOktaConfig + Get-V2024ManagedClient -Id $Id # Below is a request that includes all optional parameters - # Get-V2024MFAOktaConfig + # Get-V2024ManagedClient -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: PUT +- path: /managed-clients/{id}/status + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client-status source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" + $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-V2024ManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" + Write-Host $_.ErrorDetails } - "@ +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) - # Set Duo MFA configuration + # Get Managed Clients try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result + Get-V2024ManagedClients # Below is a request that includes all optional parameters - # Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result + # Get-V2024ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" Write-Host $_.ErrorDetails } -- path: /mfa/kba/config/answers - method: POST +- path: /managed-clients/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#update-managed-client source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" }"@ - # Set MFA KBA configuration + # Update Managed Client try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result + # Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/okta-verify/config - method: PUT +- path: /managed-clusters + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#create-managed-cluster source: | - $MfaOktaConfig = @" + $ManagedClusterRequest = @" { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" } "@ - # Set Okta MFA configuration + # Create Create Managed Cluster try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-V2024ManagedCluster -V2024ManagedClusterRequest $Result # Below is a request that includes all optional parameters - # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result + # New-V2024ManagedCluster -V2024ManagedClusterRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" Write-Host $_.ErrorDetails } -- path: /mfa/{method}/test - method: GET +- path: /managed-clusters/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#delete-managed-cluster source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - # MFA method's test configuration + # Delete Managed Cluster try { - Test-V2024MFAConfig -Method $Method + Remove-V2024ManagedCluster -Id $Id # Below is a request that includes all optional parameters - # Test-V2024MFAConfig -Method $Method + # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" Write-Host $_.ErrorDetails } -- path: /machine-accounts/{id} +- path: /managed-clusters/{id}/log-config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#get-machine-account + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-client-log-configuration source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - # Machine Account Details + # Get Managed Cluster Log Configuration try { - Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2024ClientLogConfiguration -Id $Id # Below is a request that includes all optional parameters - # Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2024ClientLogConfiguration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" Write-Host $_.ErrorDetails } -- path: /machine-accounts +- path: /managed-clusters/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#list-machine-accounts + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $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 = "identityId eq "2c9180858082150f0180893dbaf44201"" # 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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *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, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - # Machine Accounts List + # Get Managed Cluster try { - Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental + Get-V2024ManagedCluster -Id $Id # Below is a request that includes all optional parameters - # Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-V2024ManagedCluster -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" Write-Host $_.ErrorDetails } -- path: /machine-accounts/{id} - method: PATCH +- path: /managed-clusters + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#update-machine-account + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-clusters source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ - + $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) - # Update a Machine Account + # Get Managed Clusters try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + Get-V2024ManagedClusters # Below is a request that includes all optional parameters - # Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + # Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" Write-Host $_.ErrorDetails } -- path: /machine-identities - method: POST +- path: /managed-clusters/{id}/log-config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#create-machine-identity + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#put-client-log-configuration source: | - $MachineIdentity = @" - { - "created" : "2015-05-28T14:07:17Z", - "businessApplication" : "ADService", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "", - "attributes" : "{\"Region\":\"EU\"}", - "id" : "id12345", - "manuallyEdited" : true - } + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + "@ - # Create Machine Identities + # Update Managed Cluster Log Configuration try { - $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity - New-V2024MachineIdentity -V2024MachineIdentity $Result + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result # Below is a request that includes all optional parameters - # New-V2024MachineIdentity -V2024MachineIdentity $Result + # Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" Write-Host $_.ErrorDetails } -- path: /machine-identities/{id} - method: DELETE +- path: /managed-clusters/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#delete-machine-identity + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update-managed-cluster source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Delete machine identity + + # Update Managed Cluster try { - Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + # Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" Write-Host $_.ErrorDetails } -- path: /machine-identities/{id} +- path: /mfa/duo-web/config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#get-machine-identity + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Machine Identity Details + # Configuration of Duo MFA method try { - Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2024MFADuoConfig # Below is a request that includes all optional parameters - # Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2024MFADuoConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" Write-Host $_.ErrorDetails } -- path: /machine-identities +- path: /mfa/kba/config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#list-machine-identities + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Sorters = "businessApplication" # 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: **businessApplication, name** (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) - $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) + $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) - # List Machine Identities + # Configuration of KBA MFA method try { - Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental + Get-V2024MFAKbaConfig # Below is a request that includes all optional parameters - # Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset + # Get-V2024MFAKbaConfig -AllLanguages $AllLanguages } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" Write-Host $_.ErrorDetails } -- path: /machine-identities/{id} - method: PATCH +- path: /mfa/okta-verify/config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#update-machine-identity + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ - - # Update a Machine Identity + # Configuration of Okta MFA method try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + Get-V2024MFAOktaConfig # Below is a request that includes all optional parameters - # Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + # Get-V2024MFAOktaConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: POST +- path: /mfa/duo-web/config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#create-managed-client + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config source: | - $ManagedClientRequest = @" + $MfaDuoConfig = @" { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" } "@ - # Create Managed Client + # Set Duo MFA configuration try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-V2024ManagedClient -V2024ManagedClientRequest $Result + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result # Below is a request that includes all optional parameters - # New-V2024ManagedClient -V2024ManagedClientRequest $Result + # Set-V2024MFADuoConfig -V2024MfaDuoConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id} - method: DELETE +- path: /mfa/kba/config/answers + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#delete-managed-client + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ - # Delete Managed Client + + # Set MFA KBA configuration try { - Remove-V2024ManagedClient -Id $Id + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Remove-V2024ManagedClient -Id $Id + # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id} - method: GET +- path: /mfa/okta-verify/config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ - # Get Managed Client + # Set Okta MFA configuration try { - Get-V2024ManagedClient -Id $Id + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result # Below is a request that includes all optional parameters - # Get-V2024ManagedClient -Id $Id + # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status +- path: /mfa/{method}/test method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client-status + label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # Get Managed Client Status + # MFA method's test configuration try { - Get-V2024ManagedClientStatus -Id $Id -Type $Type + Test-V2024MFAConfig -Method $Method # Below is a request that includes all optional parameters - # Get-V2024ManagedClientStatus -Id $Id -Type $Type + # Test-V2024MFAConfig -Method $Method } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: GET +- path: /non-employee-approvals/{id}/approve + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-clients + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request 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) + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "Approved by manager" + } + "@ - # Get Managed Clients + # Approve a Non-Employee Request try { - Get-V2024ManagedClients + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result # Below is a request that includes all optional parameters - # Get-V2024ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id} - method: PATCH +- path: /non-employee-records + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#update-managed-client + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-record source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ - # Update Managed Client + # Create Non-Employee Record try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # Update-V2024ManagedClient -Id $Id -V2024JsonPatchOperation $Result + # New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" Write-Host $_.ErrorDetails } -- path: /managed-clusters +- path: /non-employee-requests method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#create-managed-cluster + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-request source: | - $ManagedClusterRequest = @" + $NonEmployeeRequestBody = @" { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" } "@ - # Create Create Managed Cluster + # Create Non-Employee Request try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-V2024ManagedCluster -V2024ManagedClusterRequest $Result + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result # Below is a request that includes all optional parameters - # New-V2024ManagedCluster -V2024ManagedClusterRequest $Result + # New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id} - method: DELETE +- path: /non-employee-sources + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#delete-managed-cluster + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source 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) + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ - # Delete Managed Cluster + # Create Non-Employee Source try { - Remove-V2024ManagedCluster -Id $Id + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result # Below is a request that includes all optional parameters - # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients + # New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id}/log-config - method: GET +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/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-V2024ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-V2024ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedClusters - - # Below is a request that includes all optional parameters - # 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 - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/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-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2024ClientLogConfiguration -Id $Id -V2024PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/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-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024ManagedCluster -Id $Id -V2024JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /non-employee-approvals/{id}/approve - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request - source: | - $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) - $NonEmployeeApprovalDecision = @" - { - "comment" : "Approved by manager" - } - "@ - - # Approve a Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Approve-V2024NonEmployeeRequest -Id $Id -V2024NonEmployeeApprovalDecision $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-records - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-record - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Record - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" - Write-Host $_.ErrorDetails - } -- path: /non-employee-requests - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-request - source: | - $NonEmployeeRequestBody = @" - { - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" - } - "@ - - # Create Non-Employee Request - - try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source - source: | - $NonEmployeeSourceRequestBody = @" - { - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] - } - "@ - - # Create Non-Employee Source - - try { - $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result - - # Below is a request that includes all optional parameters - # New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" - Write-Host $_.ErrorDetails - } -- path: /non-employee-sources/{sourceId}/schema-attributes - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes + label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes source: | $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id $NonEmployeeSchemaAttributeBody = @" @@ -9501,20 +9267,20 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $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) - $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) - $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) + $NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) $Sorters = "name,created" # 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, created, sourceId** (optional) # List Non-Employee Sources try { - Get-V2024NonEmployeeSources + Get-V2024NonEmployeeSources -RequestedFor $RequestedFor # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $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 @@ -11741,2330 +11507,2148 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /saved-searches method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#create-saved-search 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" - } - } + $CreateSavedSearchRequest = @" + "@ - # Create new SIM integration + # Create a saved search try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result # Below is a request that includes all optional parameters - # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + # New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} +- path: /saved-searches/{id} method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#delete-saved-search 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") + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Delete a SIM integration + # Delete document by ID try { - Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + Remove-V2024SavedSearch -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + # Remove-V2024SavedSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#execute-saved-search + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SearchArguments = @" + { + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + } + "@ + + # Execute a saved search by ID + + try { + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#get-saved-search source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Get a SIM integration details. + # Return saved search by ID try { - Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + Get-V2024SavedSearch -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + # Get-V2024SavedSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" Write-Host $_.ErrorDetails } -- path: /sim-integrations +- path: /saved-searches method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#list-saved-searches source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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 = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # 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: **owner.id**: *eq* (optional) - # List the existing SIM integrations. + # A list of Saved Searches try { - Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + Get-V2024SavedSearches # Below is a request that includes all optional parameters - # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + # Get-V2024SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH +- path: /saved-searches/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule + label: SDK_tools/sdk/powershell/v2024/methods/saved-search#put-saved-search 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]" + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SavedSearch = @" + { + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + } "@ - # Patch a SIM beforeProvisioningRule attribute. + # Updates an existing saved search try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result # Below is a request that includes all optional parameters - # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + # Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} - method: PATCH +- path: /scheduled-searches + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#create-scheduled-search 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]" + $CreateScheduledSearchRequest = @" + {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} "@ - # Patch a SIM attribute. + # Create a new scheduled search try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result # Below is a request that includes all optional parameters - # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + # New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sim-integrations/{id} - method: PUT +- path: /scheduled-searches/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#delete-scheduled-search 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" - } - } - "@ + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Update an existing SIM integration + # Delete a Scheduled Search try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + Remove-V2024ScheduledSearch -Id $Id # Below is a request that includes all optional parameters - # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + # Remove-V2024ScheduledSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies - method: POST +- path: /scheduled-searches/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#get-scheduled-search 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" - } - "@ + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Create SOD policy + # Get a Scheduled Search try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2024SodPolicy -V2024SodPolicy $Result + Get-V2024ScheduledSearch -Id $Id # Below is a request that includes all optional parameters - # New-V2024SodPolicy -V2024SodPolicy $Result + # Get-V2024ScheduledSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: DELETE +- path: /scheduled-searches + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#list-scheduled-search 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) + $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 = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # 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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - # Delete SOD policy by ID + # List scheduled searches try { - Remove-V2024SodPolicy -Id $Id + Get-V2024ScheduledSearch # Below is a request that includes all optional parameters - # Remove-V2024SodPolicy -Id $Id -Logical $Logical + # Get-V2024ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule - method: DELETE +- path: /scheduled-searches/{id}/unsubscribe + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#unsubscribe-scheduled-search 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 -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $TypedReference = @" + { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" } -- 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 + # Unsubscribe a recipient from Scheduled Search try { - Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result # Below is a request that includes all optional parameters - # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + # Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download - method: GET +- path: /scheduled-searches/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report + label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#update-scheduled-search source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" - Write-Host $_.ErrorDetails + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScheduledSearch = @" + { + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "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" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false } -- 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 + # Update an existing Scheduled Search try { - Get-V2024SodAllReportRunStatus + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result # Below is a request that includes all optional parameters - # Get-V2024SodAllReportRunStatus + # Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: GET +- path: /search/aggregate + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy + label: SDK_tools/sdk/powershell/v2024/methods/search#search-aggregate source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicy -Id $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 -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicySchedule -Id $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 -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportRunStatus -ReportResultId $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 -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportStatus -Id $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 -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 - } -- 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 -Id $Id -V2024JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result - } 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 -Id $Id -V2024SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result - } 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 -Id $Id -V2024SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result - } 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 -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024EvaluateSodPolicy -Id $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 $Result - } 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 -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024SodPolicy -Id $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 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" - Write-Host $_.ErrorDetails + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } } -- 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}} "@ + $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) - # Check SOD violations + # Perform a Search Query Aggregation try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Aggregate -V2024Search $Result # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result + # Search-V2024Aggregate -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" Write-Host $_.ErrorDetails } -- path: /sp-config/export +- path: /search/count method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config + label: SDK_tools/sdk/powershell/v2024/methods/search#search-count source: | - $ExportPayload = @" + $Search = @" { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig -V2024ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2024SpConfig -V2024ExportPayload $Result - } 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. - - # Download export job result. - - try { - Get-V2024SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -Id $Id - } 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. - - # Get export job status - - try { - Get-V2024SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -Id $Id - } 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. - - # Download import job result - - try { - Get-V2024SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -Id $Id - } 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. - - # Get import job status - - try { - Get-V2024SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" - Write-Host $_.ErrorDetails + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/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 + # Count Documents Satisfying a Query try { - Import-V2024SpConfig -Data $Data + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Count -V2024Search $Result # Below is a request that includes all optional parameters - # Import-V2024SpConfig -Data $Data -Preview $Preview -V2024Options $Options + # Search-V2024Count -V2024Search $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" Write-Host $_.ErrorDetails } -- path: /sp-config/config-objects +- path: /search/{index}/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects + label: SDK_tools/sdk/powershell/v2024/methods/search#search-get source: | + $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Get config object details + # Get a Document by ID try { - Get-V2024SpConfigObjects + Search-V2024Get -Index $Index -Id $Id # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects + # Search-V2024Get -Index $Index -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" Write-Host $_.ErrorDetails } -- path: /saved-searches +- path: /search method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#create-saved-search + label: SDK_tools/sdk/powershell/v2024/methods/search#search-post source: | - $CreateSavedSearchRequest = @" - - "@ - - # Create a saved search - - try { - $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024SavedSearch -V2024CreateSavedSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" - Write-Host $_.ErrorDetails + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } } -- path: /saved-searches/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#delete-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + "@ + $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 = 10000 # 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) - # Delete document by ID + # Perform Search try { - Remove-V2024SavedSearch -Id $Id + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Post -V2024Search $Result # Below is a request that includes all optional parameters - # Remove-V2024SavedSearch -Id $Id + # Search-V2024Post -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" Write-Host $_.ErrorDetails } -- path: /saved-searches/{id}/execute +- path: /accounts/search-attribute-config method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#execute-saved-search + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#create-search-attribute-config source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SearchArguments = @" + $SearchAttributeConfig = @" { - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } } "@ - # Execute a saved search by ID + # Create Extended Search Attributes try { - $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result # Below is a request that includes all optional parameters - # Invoke-V2024ExecuteSavedSearch -Id $Id -V2024SearchArguments $Result + # New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /saved-searches/{id} - method: GET +- path: /accounts/search-attribute-config/{name} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#get-saved-search + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#delete-search-attribute-config source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - # Return saved search by ID + # Delete Extended Search Attribute try { - Get-V2024SavedSearch -Id $Id + Remove-V2024SearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Get-V2024SavedSearch -Id $Id + # Remove-V2024SearchAttributeConfig -Name $Name } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /saved-searches +- path: /accounts/search-attribute-config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#list-saved-searches + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-search-attribute-config 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 = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # 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: **owner.id**: *eq* (optional) - # A list of Saved Searches + # List Extended Search Attributes try { - Get-V2024SavedSearches + Get-V2024SearchAttributeConfig # Below is a request that includes all optional parameters - # Get-V2024SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Get-V2024SearchAttributeConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /saved-searches/{id} - method: PUT +- path: /accounts/search-attribute-config/{name} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/saved-search#put-saved-search + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-single-search-attribute-config source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SavedSearch = @" - { - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] - }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] - }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" - }, - "upper" : { - "inclusive" : false, - "value" : "1" - } - }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] - } - "@ + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. - # Updates an existing saved search + # Get Extended Search Attribute try { - $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result + Get-V2024SingleSearchAttributeConfig -Name $Name # Below is a request that includes all optional parameters - # Send-V2024SavedSearch -Id $Id -V2024SavedSearch $Result + # Get-V2024SingleSearchAttributeConfig -Name $Name } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /scheduled-searches - method: POST +- path: /accounts/search-attribute-config/{name} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#create-scheduled-search + label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#patch-search-attribute-config source: | - $CreateScheduledSearchRequest = @" - {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} - "@ + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Create a new scheduled search + + # Update Extended Search Attribute try { - $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $Result + # Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id} - method: DELETE +- path: /segments + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#delete-scheduled-search + label: SDK_tools/sdk/powershell/v2024/methods/segments#create-segment source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $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" + } + "@ - # Delete a Scheduled Search + # Create Segment try { - Remove-V2024ScheduledSearch -Id $Id + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-V2024Segment -V2024Segment $Result # Below is a request that includes all optional parameters - # Remove-V2024ScheduledSearch -Id $Id + # New-V2024Segment -V2024Segment $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id} - method: GET +- path: /segments/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#get-scheduled-search + label: SDK_tools/sdk/powershell/v2024/methods/segments#delete-segment source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - # Get a Scheduled Search + # Delete Segment by ID try { - Get-V2024ScheduledSearch -Id $Id + Remove-V2024Segment -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ScheduledSearch -Id $Id + # Remove-V2024Segment -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" Write-Host $_.ErrorDetails } -- path: /scheduled-searches +- path: /segments/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#list-scheduled-search + label: SDK_tools/sdk/powershell/v2024/methods/segments#get-segment 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 = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # 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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - # List scheduled searches + # Get Segment by ID try { - Get-V2024ScheduledSearch + Get-V2024Segment -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Get-V2024Segment -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id}/unsubscribe - method: POST +- path: /segments + method: GET xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#unsubscribe-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $TypedReference = @" - { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - "@ + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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) - # Unsubscribe a recipient from Scheduled Search + # List Segments try { - $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result + Get-V2024Segments # Below is a request that includes all optional parameters - # Invoke-V2024UnsubscribeScheduledSearch -Id $Id -V2024TypedReference $Result + # Get-V2024Segments -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id} - method: PUT +- path: /segments/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/scheduled-search#update-scheduled-search + label: SDK_tools/sdk/powershell/v2024/methods/segments#patch-segment source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $ScheduledSearch = @" - { - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, - "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" - }, - "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "emailEmptyResults" : false - } - "@ + $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 an existing Scheduled Search + + # Update Segment try { - $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024Segment -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Update-V2024ScheduledSearch -Id $Id -V2024ScheduledSearch $Result + # Update-V2024Segment -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" Write-Host $_.ErrorDetails } -- path: /search/aggregate +- path: /service-desk-integrations method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-aggregate + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#create-service-desk-integration source: | - $Search = @" + $ServiceDeskIntegrationDto = @" { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "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", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" } "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-V2024ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integrations + 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 = "name eq "John Doe"" # 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) - # Perform a Search Query Aggregation + # List existing Service Desk integrations try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Aggregate -V2024Search $Result + Get-V2024ServiceDeskIntegrations # Below is a request that includes all optional parameters - # Search-V2024Aggregate -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count + # Get-V2024ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations" Write-Host $_.ErrorDetails } -- path: /search/count - method: POST +- path: /service-desk-integrations/status-check-configuration + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-count + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-status-check-details source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" + + # Get the time check configuration + + try { + Get-V2024StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-V2024StatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/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-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "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", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" } "@ - # Count Documents Satisfying a Query + # Update a Service Desk integration try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Count -V2024Search $Result + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Search-V2024Count -V2024Search $Result + # Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /search/{index}/{id} - method: GET +- path: /service-desk-integrations/status-check-configuration + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-get + label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#update-status-check-details source: | - $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ - # Get a Document by ID + # Update the time check configuration try { - Search-V2024Get -Index $Index -Id $Id + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result # Below is a request that includes all optional parameters - # Search-V2024Get -Index $Index -Id $Id + # Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /search +- path: /sim-integrations method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search#search-post + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration source: | - $Search = @" + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } + "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" } } - "@ - $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 = 10000 # 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) + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + } 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 -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $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") - # Perform Search + # Get a SIM integration details. try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-V2024Post -V2024Search $Result + Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Search-V2024Post -V2024Search $Result -Offset $Offset -Limit $Limit -Count $Count + # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config - method: POST +- path: /sim-integrations + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#create-search-attribute-config + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations source: | - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegrations -XSailPointExperimental $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]" "@ - # Create Extended Search Attributes + # Patch a SIM beforeProvisioningRule attribute. try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result # Below is a request that includes all optional parameters - # New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $Result + # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} - method: DELETE +- path: /sim-integrations/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#delete-search-attribute-config + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + $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]" + "@ - # Delete Extended Search Attribute + # Patch a SIM attribute. try { - Remove-V2024SearchAttributeConfig -Name $Name + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result # Below is a request that includes all optional parameters - # Remove-V2024SearchAttributeConfig -Name $Name + # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config - method: GET +- path: /sim-integrations/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-search-attribute-config + 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" + } + } + "@ - # List Extended Search Attributes + # Update an existing SIM integration try { - Get-V2024SearchAttributeConfig + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Get-V2024SearchAttributeConfig + # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} - method: GET +- path: /sod-policies + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-single-search-attribute-config + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. + $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" + } + "@ - # Get Extended Search Attribute + # Create SOD policy try { - Get-V2024SingleSearchAttributeConfig -Name $Name + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2024SodPolicy -V2024SodPolicy $Result # Below is a request that includes all optional parameters - # Get-V2024SingleSearchAttributeConfig -Name $Name + # New-V2024SodPolicy -V2024SodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} - method: PATCH +- path: /sod-policies/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/search-attribute-configuration#patch-search-attribute-config + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy source: | - $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ + $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 - # Update Extended Search Attribute + try { + Remove-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicy -Id $Id -Logical $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 { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result + Remove-V2024SodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Update-V2024SearchAttributeConfig -Name $Name -V2024JsonPatchOperation $Result + # Remove-V2024SodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" Write-Host $_.ErrorDetails } -- path: /segments - method: POST +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#create-segment + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report 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" - } - "@ + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. - # Create Segment + # Download custom violation report try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-V2024Segment -V2024Segment $Result + Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName # Below is a request that includes all optional parameters - # New-V2024Segment -V2024Segment $Result + # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" Write-Host $_.ErrorDetails } -- path: /segments/{id} - method: DELETE +- path: /sod-violation-report/{reportResultId}/download + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#delete-segment + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - # Delete Segment by ID + # Download violation report try { - Remove-V2024Segment -Id $Id + Get-V2024DefaultViolationReport -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Remove-V2024Segment -Id $Id + # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" Write-Host $_.ErrorDetails } -- path: /segments/{id} +- path: /sod-violation-report method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#get-segment + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - # Get Segment by ID + # Get multi-report run task status try { - Get-V2024Segment -Id $Id + Get-V2024SodAllReportRunStatus # Below is a request that includes all optional parameters - # Get-V2024Segment -Id $Id + # Get-V2024SodAllReportRunStatus } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" Write-Host $_.ErrorDetails } -- path: /segments +- path: /sod-policies/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#list-segments + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy 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) + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - # List Segments + # Get SOD policy by ID try { - Get-V2024Segments + Get-V2024SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Get-V2024Segments -Limit $Limit -Offset $Offset -Count $Count + # Get-V2024SodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" Write-Host $_.ErrorDetails } -- path: /segments/{id} - method: PATCH +- path: /sod-policies/{id}/schedule + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/segments#patch-segment + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule 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}}]}}}]"@ - + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - # Update Segment + # Get SOD policy schedule try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024Segment -Id $Id -RequestBody $Result + Get-V2024SodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Update-V2024Segment -Id $Id -RequestBody $Result + # Get-V2024SodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations - method: POST +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#create-service-desk-integration + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "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", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - # Create new Service Desk integration + # Get violation report run status try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result + Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $Result + # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} - method: DELETE +- path: /sod-policies/{id}/violation-report + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#delete-service-desk-integration + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status source: | - $Id = "anId" # String | ID of Service Desk integration to delete + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - # Delete a Service Desk integration + # Get SOD violation report status try { - Remove-V2024ServiceDeskIntegration -Id $Id + Get-V2024SodViolationReportStatus -Id $Id # Below is a request that includes all optional parameters - # Remove-V2024ServiceDeskIntegration -Id $Id + # Get-V2024SodViolationReportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} +- path: /sod-policies method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies source: | - $Id = "anId" # String | ID of the Service Desk integration to get + $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) - # Get a Service Desk integration + # List SOD policies try { - Get-V2024ServiceDeskIntegration -Id $Id + Get-V2024SodPolicies # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegration -Id $Id + # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/templates/{scriptName} - method: GET +- path: /sod-policies/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-template + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Service Desk integration template by scriptName + + # Patch SOD policy by ID try { - Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName + # Update-V2024SodPolicy -Id $Id -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-types - source: | +- 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 + } + "@ - # List Service Desk integration types + # Update SOD Policy schedule try { - Get-V2024ServiceDeskIntegrationTypes + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result # Below is a request that includes all optional parameters - # Get-V2024ServiceDeskIntegrationTypes + # Send-V2024PolicySchedule -Id $Id -V2024SodPolicySchedule $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTypes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations - method: GET +- path: /sod-policies/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integrations + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy 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 = "name eq "John Doe"" # 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-V2024ServiceDeskIntegrations - - # Below is a request that includes all optional parameters - # 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 + $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" } -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-status-check-details - source: | + "@ - # Get the time check configuration + # Update SOD policy by ID try { - Get-V2024StatusCheckDetails + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result # Below is a request that includes all optional parameters - # Get-V2024StatusCheckDetails + # Send-V2024SodPolicy -Id $Id -V2024SodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusCheckDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} - method: PATCH +- path: /sod-policies/{id}/evaluate + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#patch-service-desk-integration + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - # Patch a Service Desk Integration + # Evaluate one policy by ID try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + Start-V2024EvaluateSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Update-V2024ServiceDeskIntegration -Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + # Start-V2024EvaluateSodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} - method: PUT +- path: /sod-violation-report/run + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#put-service-desk-integration + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" + $MultiPolicyRequest = @" { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "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", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] } "@ - # Update a Service Desk integration + # Runs all policies for org try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result + Start-V2024SodAllPoliciesForOrg # Below is a request that includes all optional parameters - # Send-V2024ServiceDeskIntegration -Id $Id -V2024ServiceDeskIntegrationDto $Result + # Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/status-check-configuration - method: PUT +- path: /sod-policies/{id}/violation-report/run + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#update-status-check-details + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - # Update the time check configuration + # Runs SOD policy violation report try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result + Start-V2024SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $Result + # Start-V2024SodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sod-violations/predict + 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/sod-violations#start-predict-sod-violations source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN 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" + } ] + } + "@ - # Finds status of source usage + # Predict SOD violations for identity. try { - Get-V2024StatusBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Get-V2024StatusBySourceId -SourceId $SourceId + # Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries - method: GET +- path: /sod-violations/check + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check 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) + $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}} + "@ - # Returns source usage insights + # Check SOD violations try { - Get-V2024UsagesBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result # Below is a request that includes all optional parameters - # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -15374,158 +14958,347 @@ }"@ - # Bulk Update Provisioning Policies + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policy + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-entitlement-request-config + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceEntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Update Source Entitlement Request Configuration + + try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schedule + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schedule (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schema + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result + } catch { + 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 -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024StatusBySourceId -SourceId $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 -SourceId $SourceId + + # Below is a request that includes all optional parameters + # 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 + } +- 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-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -V2024ProvisioningPolicyDto $Result + # Export-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" Write-Host $_.ErrorDetails } -- path: /sources/{sourceId}/provisioning-policies/{usageType} - method: PATCH +- path: /sp-config/export/{id}/download + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policy + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $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") - # Partial update of Provisioning Policy + # Download export job result. try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result + Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -V2024JsonPatchOperation $Result + # Get-V2024SpConfigExport -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" Write-Host $_.ErrorDetails } -- path: /sources/{id} - method: PATCH +- path: /sp-config/export/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $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") - # Update Source (Partial) + # Get export job status try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result + Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024Source -Id $Id -V2024JsonPatchOperation $Result + # Get-V2024SpConfigExportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" Write-Host $_.ErrorDetails } -- path: /sources/{id}/entitlement-request-config - method: PUT +- path: /sp-config/import/{id}/download + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-entitlement-request-config + 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") - $SourceEntitlementRequestConfig = @" - { - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } - } - "@ - # Update Source Entitlement Request Configuration + # Download import job result try { - $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result + Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result + # Get-V2024SpConfigImport -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" Write-Host $_.ErrorDetails } -- path: /sources/{sourceId}/schedules/{scheduleType} - method: PATCH +- path: /sp-config/import/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schedule + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $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") - # Update Source Schedule (Partial) + # Get import job status try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result + Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -V2024JsonPatchOperation $Result + # Get-V2024SpConfigImportStatus -Id $Id -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" Write-Host $_.ErrorDetails } -- path: /sources/{sourceId}/schemas/{schemaId} - method: PATCH +- path: /sp-config/import + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sources#update-source-schema + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ + $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 - # Update Source Schema (Partial) + try { + Import-V2024SpConfig -XSailPointExperimental $XSailPointExperimental -Data $Data + + # Below is a request that includes all optional parameters + # 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 + } +- 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 { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result + Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -V2024JsonPatchOperation $Result + # Get-V2024SpConfigObjects -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" Write-Host $_.ErrorDetails } - path: /suggested-entitlement-description-batches/{batchId}/stats @@ -15535,14 +15308,15 @@ label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batch-stats source: | $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Submit Sed Batch Stats Request try { - Get-V2024SedBatchStats -BatchId $BatchId + Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SedBatchStats -BatchId $BatchId + # Get-V2024SedBatchStats -BatchId $BatchId -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" Write-Host $_.ErrorDetails @@ -15553,14 +15327,15 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batches source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # List Sed Batch Request try { - Get-V2024SedBatches + Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024SedBatches + # Get-V2024SedBatches -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" Write-Host $_.ErrorDetails @@ -15571,22 +15346,22 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#list-seds 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) + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) $Filters = "displayName co "Read and Write"" # 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) $Sorters = "sorters=displayName" # 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: **displayName, sourceName, status** (optional) - $CountOnly = $false # 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) - $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) - $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) + $Count = $false # 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. (optional) + $CountOnly = $false # 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) + $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) # List Suggested Entitlement Descriptions try { - Get-V2024Seds + Get-V2024Seds -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $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 @@ -15624,6 +15399,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-approval source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedApproval = @"{ "items" : "016629d1-1d25-463f-97f3-c6686846650" }"@ @@ -15633,10 +15409,10 @@ try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-V2024SedApproval -V2024SedApproval $Result + Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result # Below is a request that includes all optional parameters - # Submit-V2024SedApproval -V2024SedApproval $Result + # Submit-V2024SedApproval -XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" Write-Host $_.ErrorDetails @@ -15647,6 +15423,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-assignment source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedAssignment = @" { "assignee" : { @@ -15661,10 +15438,10 @@ try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-V2024SedAssignment -V2024SedAssignment $Result + Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result # Below is a request that includes all optional parameters - # Submit-V2024SedAssignment -V2024SedAssignment $Result + # Submit-V2024SedAssignment -XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" Write-Host $_.ErrorDetails @@ -15675,6 +15452,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-batch-request source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $SedBatchRequest = @" { "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], @@ -15685,10 +15463,10 @@ # Submit Sed Batch Request try { - Submit-V2024SedBatchRequest + Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Submit-V2024SedBatchRequest -V2024SedBatchRequest $Result + # Submit-V2024SedBatchRequest -XSailPointExperimental $XSailPointExperimental -V2024SedBatchRequest $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" Write-Host $_.ErrorDetails @@ -16026,14 +15804,15 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/tenant#get-tenant source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") # Get Tenant Information. try { - Get-V2024Tenant + Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Tenant + # Get-V2024Tenant -XSailPointExperimental $XSailPointExperimental } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" Write-Host $_.ErrorDetails @@ -16634,887 +16413,887 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/approve/{approvalItemId} +- path: /workflow-executions/{id}/cancel method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-item + label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - # Approve an Approval Item + # Cancel Workflow Execution by ID try { - Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Suspend-V2024WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Suspend-V2024WorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-approve/{id} +- path: /workflows/execute/external/{id} method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-items-in-bulk + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" - # Bulk approve Approval Items + "@ + + # Execute Workflow via External Trigger try { - Approve-V2024ApprovalItemsInBulk -Id $Id + New-V2024ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Approve-V2024ApprovalItemsInBulk -Id $Id + # New-V2024ExternalExecuteWorkflow -Id $Id -V2024CreateExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id} +- path: /workflows method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $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')]}}} + "@ - # Complete a Work Item + # Create Workflow try { - Complete-V2024WorkItem -Id $Id + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow -V2024CreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # Complete-V2024WorkItem -Id $Id + # New-V2024Workflow -V2024CreateWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/completed - method: GET +- path: /workflows/{id}/external/oauth-clients + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-completed-work-items + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger 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) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Completed Work Items + # Generate External Trigger OAuth Client try { - Get-V2024CompletedWorkItems + New-V2024WorkflowExternalTrigger -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + # New-V2024WorkflowExternalTrigger -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" Write-Host $_.ErrorDetails } -- path: /work-items/completed/count - method: GET +- path: /workflows/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-completed-work-items + label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - # Count Completed Work Items + # Delete Workflow By Id try { - Get-V2024CountCompletedWorkItems + Remove-V2024Workflow -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CountCompletedWorkItems -OwnerId $OwnerId + # Remove-V2024Workflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/count +- path: /workflows/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-work-items + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Count Work Items + # Get Workflow By Id try { - Get-V2024CountWorkItems + Get-V2024Workflow -Id $Id # Below is a request that includes all optional parameters - # Get-V2024CountWorkItems -OwnerId $OwnerId + # Get-V2024Workflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id} +- path: /workflow-executions/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-item + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - # Get a Work Item + # Get Workflow Execution try { - Get-V2024WorkItem -Id $Id + Get-V2024WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkItem -Id $Id + # Get-V2024WorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" Write-Host $_.ErrorDetails } -- path: /work-items/summary +- path: /workflow-executions/{id}/history method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-items-summary + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - # Work Items Summary + # Get Workflow Execution History try { - Get-V2024WorkItemsSummary + Get-V2024WorkflowExecutionHistory -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkItemsSummary -OwnerId $OwnerId + # Get-V2024WorkflowExecutionHistory -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" Write-Host $_.ErrorDetails } -- path: /work-items +- path: /workflows/{id}/executions method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#list-work-items + 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) - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + $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 Work Items + # List Workflow Executions try { - Get-V2024WorkItems + Get-V2024WorkflowExecutions -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST +- path: /workflow-library + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-item + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + $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) - # Reject an Approval Item + # List Complete Workflow Library try { - Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Get-V2024CompleteWorkflowLibrary # Below is a request that includes all optional parameters - # Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-reject/{id} - method: POST +- path: /workflow-library/actions + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-items-in-bulk + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $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) - # Bulk reject Approval Items + # List Workflow Library Actions try { - Deny-V2024ApprovalItemsInBulk -Id $Id + Get-V2024WorkflowLibraryActions # Below is a request that includes all optional parameters - # Deny-V2024ApprovalItemsInBulk -Id $Id + # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/forward - method: POST +- path: /workflow-library/operators + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#send-work-item-forward + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators 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 + # List Workflow Library Operators try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result + Get-V2024WorkflowLibraryOperators # Below is a request that includes all optional parameters - # Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result + # Get-V2024WorkflowLibraryOperators } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/submit-account-selection - method: POST +- path: /workflow-library/triggers + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-items#submit-account-selection + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + $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) - # Submit Account Selections + # List Workflow Library Triggers try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-V2024AccountSelection -Id $Id -RequestBody $Result + Get-V2024WorkflowLibraryTriggers # Below is a request that includes all optional parameters - # Submit-V2024AccountSelection -Id $Id -RequestBody $Result + # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations - method: POST +- path: /workflows + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#create-reassignment-configuration + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ - # Create a Reassignment Configuration + # List Workflows try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + Get-V2024Workflows # Below is a request that includes all optional parameters - # New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + # Get-V2024Workflows } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId}/{configType} - method: DELETE +- path: /workflows/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#delete-reassignment-configuration + label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Delete Reassignment Configuration + + # Patch Workflow try { - Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + # Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId}/evaluate/{configType} - method: GET +- path: /workflows/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration + label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - - $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + $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 + } + "@ - # Evaluate Reassignment Configuration + # Update Workflow try { - Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result # Below is a request that includes all optional parameters - # Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters + # Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/types - method: GET +- path: /workflows/execute/external/{id}/test + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-config-types + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" - # List Reassignment Config Types + "@ + + # Test Workflow via External Trigger try { - Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental + Test-V2024ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental + # Test-V2024ExternalExecuteWorkflow -Id $Id -V2024TestExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId} - method: GET +- path: /workflows/{id}/test + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-configuration + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $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}]}} + "@ - # Get Reassignment Configuration + # Test Workflow By Id try { - Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental + # Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/tenant-config - method: GET +- path: /work-items/{id}/approve/{approvalItemId} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-tenant-config-configuration + label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-item source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Get Tenant-wide Reassignment Configuration settings + # Approve an Approval Item try { - Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental + Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental + # Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations - method: GET +- path: /work-items/bulk-approve/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#list-reassignment-configurations + label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-items-in-bulk source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # List Reassignment Configurations + # Bulk approve Approval Items try { - Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental + Approve-V2024ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental + # Approve-V2024ApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/{identityId} - method: PUT +- path: /work-items/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-reassignment-config + label: SDK_tools/sdk/powershell/v2024/methods/work-items#complete-work-item source: | - $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $ConfigurationItemRequest = @" - { - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" - } - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Update Reassignment Configuration + # Complete a Work Item try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + Complete-V2024WorkItem -Id $Id # Below is a request that includes all optional parameters - # Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + # Complete-V2024WorkItem -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" Write-Host $_.ErrorDetails } -- path: /reassignment-configurations/tenant-config - method: PUT +- path: /work-items/completed + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-tenant-configuration + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-completed-work-items source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $TenantConfigurationRequest = @" - { - "configDetails" : { - "disabled" : true - } - } - "@ + $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) - # Update Tenant-wide Reassignment Configuration settings + # Completed Work Items try { - $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result + Get-V2024CompletedWorkItems # Below is a request that includes all optional parameters - # Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result + # Get-V2024CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST +- path: /work-items/completed/count + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-completed-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # Cancel Workflow Execution by ID + # Count Completed Work Items try { - Suspend-V2024WorkflowExecution -Id $Id + Get-V2024CountCompletedWorkItems # Below is a request that includes all optional parameters - # Suspend-V2024WorkflowExecution -Id $Id + # Get-V2024CountCompletedWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id} - method: POST +- path: /work-items/count + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-count-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - # Execute Workflow via External Trigger + # Count Work Items try { - New-V2024ExternalExecuteWorkflow -Id $Id + Get-V2024CountWorkItems # Below is a request that includes all optional parameters - # New-V2024ExternalExecuteWorkflow -Id $Id -V2024CreateExternalExecuteWorkflowRequest $Result + # Get-V2024CountWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" Write-Host $_.ErrorDetails } -- path: /workflows - method: POST +- path: /work-items/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-item 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')]}}} - "@ + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - # Create Workflow + # Get a Work Item try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2024Workflow -V2024CreateWorkflowRequest $Result + Get-V2024WorkItem -Id $Id # Below is a request that includes all optional parameters - # New-V2024Workflow -V2024CreateWorkflowRequest $Result + # Get-V2024WorkItem -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/external/oauth-clients - method: POST +- path: /work-items/summary + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger + label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-work-items-summary source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # Generate External Trigger OAuth Client + # Work Items Summary try { - New-V2024WorkflowExternalTrigger -Id $Id + Get-V2024WorkItemsSummary # Below is a request that includes all optional parameters - # New-V2024WorkflowExternalTrigger -Id $Id + # Get-V2024WorkItemsSummary -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: DELETE +- path: /work-items + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-items#list-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $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) - # Delete Workflow By Id + # List Work Items try { - Remove-V2024Workflow -Id $Id + Get-V2024WorkItems # Below is a request that includes all optional parameters - # Remove-V2024Workflow -Id $Id + # Get-V2024WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: GET +- path: /work-items/{id}/reject/{approvalItemId} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Get Workflow By Id + # Reject an Approval Item try { - Get-V2024Workflow -Id $Id + Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Get-V2024Workflow -Id $Id + # Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id} - method: GET +- path: /work-items/bulk-reject/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution + label: SDK_tools/sdk/powershell/v2024/methods/work-items#reject-approval-items-in-bulk source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Get Workflow Execution + # Bulk reject Approval Items try { - Get-V2024WorkflowExecution -Id $Id + Deny-V2024ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecution -Id $Id + # Deny-V2024ApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/history - method: GET +- path: /work-items/{id}/forward + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history + label: SDK_tools/sdk/powershell/v2024/methods/work-items#send-work-item-forward source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ - # Get Workflow Execution History + # Forward a Work Item try { - Get-V2024WorkflowExecutionHistory -Id $Id + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutionHistory -Id $Id + # Send-V2024WorkItemForward -Id $Id -V2024WorkItemForward $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/executions - method: GET +- path: /work-items/{id}/submit-account-selection + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions + label: SDK_tools/sdk/powershell/v2024/methods/work-items#submit-account-selection 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) + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - # List Workflow Executions + # Submit Account Selections try { - Get-V2024WorkflowExecutions -Id $Id + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-V2024AccountSelection -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + # Submit-V2024AccountSelection -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" Write-Host $_.ErrorDetails } -- path: /workflow-library - method: GET +- path: /reassignment-configurations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#create-reassignment-configuration 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) + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ - # List Complete Workflow Library + # Create a Reassignment Configuration try { - Get-V2024CompleteWorkflowLibrary + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + # New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-library/actions - method: GET +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#delete-reassignment-configuration 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) + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List Workflow Library Actions + # Delete Reassignment Configuration try { - Get-V2024WorkflowLibraryActions + Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + # Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-library/operators +- path: /reassignment-configurations/{identityId}/evaluate/{configType} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - # List Workflow Library Operators + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration try { - Get-V2024WorkflowLibraryOperators + Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryOperators + # Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $ExclusionFilters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-library/triggers +- path: /reassignment-configurations/types method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-config-types 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) + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List Workflow Library Triggers + # List Reassignment Config Types try { - Get-V2024WorkflowLibraryTriggers + Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + # Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" Write-Host $_.ErrorDetails } -- path: /workflows +- path: /reassignment-configurations/{identityId} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-configuration source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List Workflows + # Get Reassignment Configuration try { - Get-V2024Workflows + Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Get-V2024Workflows + # Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: PATCH +- path: /reassignment-configurations/tenant-config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#get-tenant-config-configuration source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Patch Workflow + # Get Tenant-wide Reassignment Configuration settings try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result + Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Update-V2024Workflow -Id $Id -V2024JsonPatchOperation $Result + # Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: PUT +- path: /reassignment-configurations + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#list-reassignment-configurations 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 - } - "@ + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Update Workflow + # List Reassignment Configurations try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result + Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental # Below is a request that includes all optional parameters - # Send-V2024Workflow -Id $Id -V2024WorkflowBody $Result + # Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id}/test - method: POST +- path: /reassignment-configurations/{identityId} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-reassignment-config source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } "@ - # Test Workflow via External Trigger + # Update Reassignment Configuration try { - Test-V2024ExternalExecuteWorkflow -Id $Id + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result # Below is a request that includes all optional parameters - # Test-V2024ExternalExecuteWorkflow -Id $Id -V2024TestExternalExecuteWorkflowRequest $Result + # Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/test - method: POST +- path: /reassignment-configurations/tenant-config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow + label: SDK_tools/sdk/powershell/v2024/methods/work-reassignment#put-tenant-configuration 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}]}} + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } "@ - # Test Workflow By Id + # Update Tenant-wide Reassignment Configuration settings try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result # Below is a request that includes all optional parameters - # Test-V2024Workflow -Id $Id -V2024TestWorkflowRequest $Result + # Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" Write-Host $_.ErrorDetails } diff --git a/static/code-examples/v3/code_examples_overlay.yaml b/static/code-examples/v3/code_examples_overlay.yaml index 12eb2b3029b9..55ebb86abeb2 100644 --- a/static/code-examples/v3/code_examples_overlay.yaml +++ b/static/code-examples/v3/code_examples_overlay.yaml @@ -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: @@ -812,8 +789,8 @@ $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) $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (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, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) # Accounts List @@ -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: @@ -3088,7 +3088,7 @@ } "@ - # Create Identity Profile + # Create an Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -3106,9 +3106,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#delete-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. - # Delete Identity Profile + # Delete an Identity Profile try { Remove-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -3189,9 +3189,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#get-identity-profile source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. - # Get Identity Profile + # Get single Identity Profile try { Get-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -3293,10 +3293,10 @@ $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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) + $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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (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, priority, created, modified, owner.id, owner.name** (optional) - # List Identity Profiles + # Identity Profiles List try { Get-IdentityProfiles @@ -3380,7 +3380,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#update-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -3388,7 +3388,7 @@ }"@ - # Update Identity Profile + # Update the Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -3560,622 +3560,622 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" Write-Host $_.ErrorDetails } -- path: /mfa/{method}/delete - method: DELETE +- path: /managed-clients + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#delete-mfa-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ - # Delete MFA method configuration + # Create Managed Client try { - Remove-MFAConfig -Method $Method + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-ManagedClient -ManagedClientRequest $Result # Below is a request that includes all optional parameters - # Remove-MFAConfig -Method $Method + # New-ManagedClient -ManagedClientRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: GET +- path: /managed-clients/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-duo-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Configuration of Duo MFA method + # Delete Managed Client try { - Get-MFADuoConfig + Remove-ManagedClient -Id $Id # Below is a request that includes all optional parameters - # Get-MFADuoConfig + # Remove-ManagedClient -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/kba/config +- path: /managed-clients/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-kba-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client 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) + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Configuration of KBA MFA method + # Get Managed Client try { - Get-MFAKbaConfig + Get-ManagedClient -Id $Id # Below is a request that includes all optional parameters - # Get-MFAKbaConfig -AllLanguages $AllLanguages + # Get-ManagedClient -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/okta-verify/config +- path: /managed-clients/{id}/status method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-okta-config + 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. - # Configuration of Okta MFA method + # Get Managed Client Status try { - Get-MFAOktaConfig + Get-ManagedClientStatus -Id $Id -Type $Type # Below is a request that includes all optional parameters - # Get-MFAOktaConfig + # Get-ManagedClientStatus -Id $Id -Type $Type } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: PUT +- path: /managed-clients + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-duo-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ + $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) - # Set Duo MFA configuration + # Get Managed Clients try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-MFADuoConfig -MfaDuoConfig $Result + Get-ManagedClients # Below is a request that includes all optional parameters - # Set-MFADuoConfig -MfaDuoConfig $Result + # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" Write-Host $_.ErrorDetails } -- path: /mfa/kba/config/answers - method: POST +- path: /managed-clients/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfakba-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" }"@ - # Set MFA KBA configuration + # Update Managed Client try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-MFAKBAConfig -KbaAnswerRequestItem $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedClient -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Set-MFAKBAConfig -KbaAnswerRequestItem $Result + # Update-ManagedClient -Id $Id -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" Write-Host $_.ErrorDetails } -- path: /mfa/okta-verify/config - method: PUT +- path: /managed-clusters + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-okta-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster source: | - $MfaOktaConfig = @" + $ManagedClusterRequest = @" { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" } "@ - # Set Okta MFA configuration + # Create Create Managed Cluster try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-MFAOktaConfig -MfaOktaConfig $Result + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-ManagedCluster -ManagedClusterRequest $Result # Below is a request that includes all optional parameters - # Set-MFAOktaConfig -MfaOktaConfig $Result + # New-ManagedCluster -ManagedClusterRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" Write-Host $_.ErrorDetails } -- path: /mfa/{method}/test - method: GET +- path: /managed-clusters/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#test-mfa-config + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - # MFA method's test configuration + # Delete Managed Cluster try { - Test-MFAConfig -Method $Method + Remove-ManagedCluster -Id $Id # Below is a request that includes all optional parameters - # Test-MFAConfig -Method $Method + # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" Write-Host $_.ErrorDetails } -- path: /mfa/token/send - method: POST +- path: /managed-clusters/{id}/log-config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#create-send-token + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration source: | - $SendTokenRequest = @" - { - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK" - } - "@ + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - # Create and send user token + # Get Managed Cluster Log Configuration try { - $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest - New-SendToken -SendTokenRequest $Result + Get-ClientLogConfiguration -Id $Id # Below is a request that includes all optional parameters - # New-SendToken -SendTokenRequest $Result + # Get-ClientLogConfiguration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" Write-Host $_.ErrorDetails } -- path: /mfa/{method}/poll - method: POST +- path: /managed-clusters/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#ping-verification-status + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' - $VerificationPollRequest = @" - { - "requestId" : "089899f13a8f4da7824996191587bab9" - } - "@ + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - # Polling MFA method by VerificationPollRequest + # Get Managed Cluster try { - $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest - Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result + Get-ManagedCluster -Id $Id # Below is a request that includes all optional parameters - # Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result + # Get-ManagedCluster -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/verify - method: POST +- path: /managed-clusters + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-duo-verify-request + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters source: | - $DuoVerificationRequest = @" - { - "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", - "userId" : "2c9180947f0ef465017f215cbcfd004b" - } - "@ + $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) - # Verifying authentication via Duo method + # Get Managed Clusters try { - $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest - Send-DuoVerifyRequest -DuoVerificationRequest $Result + Get-ManagedClusters # Below is a request that includes all optional parameters - # Send-DuoVerifyRequest -DuoVerificationRequest $Result + # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" Write-Host $_.ErrorDetails } -- path: /mfa/kba/authenticate - method: POST +- path: /managed-clusters/{id}/log-config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-kba-answers + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + "@ - # Authenticate KBA provided MFA method + # Update Managed Cluster Log Configuration try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Send-KbaAnswers -KbaAnswerRequestItem $Result + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result # Below is a request that includes all optional parameters - # Send-KbaAnswers -KbaAnswerRequestItem $Result + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" Write-Host $_.ErrorDetails } -- path: /mfa/okta-verify/verify - method: POST +- path: /managed-clusters/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-okta-verify-request + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster source: | - $OktaVerificationRequest = @" - { - "userId" : "example@mail.com" - } - "@ + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - # Verifying authentication via Okta method + + # Update Managed Cluster try { - $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest - Send-OktaVerifyRequest -OktaVerificationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedCluster -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Send-OktaVerifyRequest -OktaVerificationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" - Write-Host $_.ErrorDetails - } -- path: /mfa/token/authenticate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-token-auth-request - source: | - $TokenAuthRequest = @" - { - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK", - "token" : "12345" - } - "@ - - # Authenticate Token provided MFA method - - try { - $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest - Send-TokenAuthRequest -TokenAuthRequest $Result - - # Below is a request that includes all optional parameters - # Send-TokenAuthRequest -TokenAuthRequest $Result + # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: POST +- path: /mfa/{method}/delete + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#delete-mfa-config source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # Create Managed Client + # Delete MFA method configuration try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-ManagedClient -ManagedClientRequest $Result + Remove-MFAConfig -Method $Method # Below is a request that includes all optional parameters - # New-ManagedClient -ManagedClientRequest $Result + # Remove-MFAConfig -Method $Method } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id} - method: DELETE +- path: /mfa/duo-web/config + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-duo-config source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Delete Managed Client + # Configuration of Duo MFA method try { - Remove-ManagedClient -Id $Id + Get-MFADuoConfig # Below is a request that includes all optional parameters - # Remove-ManagedClient -Id $Id + # Get-MFADuoConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id} +- path: /mfa/kba/config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-kba-config source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $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) - # Get Managed Client + # Configuration of KBA MFA method try { - Get-ManagedClient -Id $Id + Get-MFAKbaConfig # Below is a request that includes all optional parameters - # Get-ManagedClient -Id $Id + # Get-MFAKbaConfig -AllLanguages $AllLanguages } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status +- path: /mfa/okta-verify/config method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-okta-config 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 + # Configuration of Okta MFA method try { - Get-ManagedClientStatus -Id $Id -Type $Type + Get-MFAOktaConfig # Below is a request that includes all optional parameters - # Get-ManagedClientStatus -Id $Id -Type $Type + # Get-MFAOktaConfig } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: GET +- path: /mfa/duo-web/config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-duo-config 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) + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ - # Get Managed Clients + # Set Duo MFA configuration try { - Get-ManagedClients + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-MFADuoConfig -MfaDuoConfig $Result # Below is a request that includes all optional parameters - # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Set-MFADuoConfig -MfaDuoConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id} - method: PATCH +- path: /mfa/kba/config/answers + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfakba-config source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" }"@ - # Update Managed Client + # Set MFA KBA configuration try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedClient -Id $Id -JsonPatchOperation $Result + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-MFAKBAConfig -KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Update-ManagedClient -Id $Id -JsonPatchOperation $Result + # Set-MFAKBAConfig -KbaAnswerRequestItem $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" Write-Host $_.ErrorDetails } -- path: /managed-clusters - method: POST +- path: /mfa/okta-verify/config + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#set-mfa-okta-config source: | - $ManagedClusterRequest = @" + $MfaOktaConfig = @" { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" } "@ - # Create Create Managed Cluster + # Set Okta MFA configuration try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-ManagedCluster -ManagedClusterRequest $Result + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-MFAOktaConfig -MfaOktaConfig $Result # Below is a request that includes all optional parameters - # New-ManagedCluster -ManagedClusterRequest $Result + # Set-MFAOktaConfig -MfaOktaConfig $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id} - method: DELETE +- path: /mfa/{method}/test + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster + label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#test-mfa-config 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) + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # Delete Managed Cluster + # MFA method's test configuration try { - Remove-ManagedCluster -Id $Id + Test-MFAConfig -Method $Method # Below is a request that includes all optional parameters - # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients + # Test-MFAConfig -Method $Method } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id}/log-config - method: GET +- path: /mfa/token/send + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#create-send-token source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + $SendTokenRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } + "@ - # Get Managed Cluster Log Configuration + # Create and send user token try { - Get-ClientLogConfiguration -Id $Id + $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest + New-SendToken -SendTokenRequest $Result # Below is a request that includes all optional parameters - # Get-ClientLogConfiguration -Id $Id + # New-SendToken -SendTokenRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id} - method: GET +- path: /mfa/{method}/poll + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#ping-verification-status source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + $VerificationPollRequest = @" + { + "requestId" : "089899f13a8f4da7824996191587bab9" + } + "@ - # Get Managed Cluster + # Polling MFA method by VerificationPollRequest try { - Get-ManagedCluster -Id $Id + $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest + Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result # Below is a request that includes all optional parameters - # Get-ManagedCluster -Id $Id + # Ping-VerificationStatus -Method $Method -VerificationPollRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" Write-Host $_.ErrorDetails } -- path: /managed-clusters - method: GET +- path: /mfa/duo-web/verify + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-duo-verify-request 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 + $DuoVerificationRequest = @" + { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } + "@ + + # Verifying authentication via Duo method try { - Get-ManagedClusters + $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest + Send-DuoVerifyRequest -DuoVerificationRequest $Result # Below is a request that includes all optional parameters - # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Send-DuoVerifyRequest -DuoVerificationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id}/log-config - method: PUT +- path: /mfa/kba/authenticate + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-kba-answers source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ - "@ - # Update Managed Cluster Log Configuration + # Authenticate KBA provided MFA method try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Send-KbaAnswers -KbaAnswerRequestItem $Result # Below is a request that includes all optional parameters - # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + # Send-KbaAnswers -KbaAnswerRequestItem $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" Write-Host $_.ErrorDetails } -- path: /managed-clusters/{id} - method: PATCH +- path: /mfa/okta-verify/verify + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-okta-verify-request source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ + $OktaVerificationRequest = @" + { + "userId" : "example@mail.com" + } + "@ + # Verifying authentication via Okta method - # Update Managed Cluster + try { + $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest + Send-OktaVerifyRequest -OktaVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-OktaVerifyRequest -OktaVerificationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/mfa-controller#send-token-auth-request + source: | + $TokenAuthRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } + "@ + + # Authenticate Token provided MFA method try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest + Send-TokenAuthRequest -TokenAuthRequest $Result # Below is a request that includes all optional parameters - # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + # Send-TokenAuthRequest -TokenAuthRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" Write-Host $_.ErrorDetails } - path: /non-employee-approvals/{id}/approve @@ -4776,20 +4776,20 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-sources source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $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) - $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) - $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) + $NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) $Sorters = "name,created" # 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, created, sourceId** (optional) # List Non-Employee Sources try { - Get-NonEmployeeSources + Get-NonEmployeeSources -RequestedFor $RequestedFor # Below is a request that includes all optional parameters - # Get-NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + # Get-NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" Write-Host $_.ErrorDetails @@ -6128,313 +6128,314 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" Write-Host $_.ErrorDetails } -- path: /sod-policies +- path: /saved-searches method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy + label: SDK_tools/sdk/powershell/v3/methods/saved-search#create-saved-search 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" - } + $CreateSavedSearchRequest = @" + "@ - # Create SOD policy + # Create a saved search try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-SodPolicy -SodPolicy $Result + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-SavedSearch -CreateSavedSearchRequest $Result # Below is a request that includes all optional parameters - # New-SodPolicy -SodPolicy $Result + # New-SavedSearch -CreateSavedSearchRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} +- path: /saved-searches/{id} method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy + label: SDK_tools/sdk/powershell/v3/methods/saved-search#delete-saved-search 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) + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Delete SOD policy by ID + # Delete document by ID try { - Remove-SodPolicy -Id $Id + Remove-SavedSearch -Id $Id # Below is a request that includes all optional parameters - # Remove-SodPolicy -Id $Id -Logical $Logical + # Remove-SavedSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule - method: DELETE +- path: /saved-searches/{id}/execute + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule + label: SDK_tools/sdk/powershell/v3/methods/saved-search#execute-saved-search source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SearchArguments = @" + { + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + } + "@ - # Delete SOD policy schedule + # Execute a saved search by ID try { - Remove-SodPolicySchedule -Id $Id + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result # Below is a request that includes all optional parameters - # Remove-SodPolicySchedule -Id $Id + # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download/{fileName} +- path: /saved-searches/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report + label: SDK_tools/sdk/powershell/v3/methods/saved-search#get-saved-search source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Download custom violation report + # Return saved search by ID try { - Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + Get-SavedSearch -Id $Id # Below is a request that includes all optional parameters - # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + # Get-SavedSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch" Write-Host $_.ErrorDetails } -- path: /sod-violation-report/{reportResultId}/download +- path: /saved-searches method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report + label: SDK_tools/sdk/powershell/v3/methods/saved-search#list-saved-searches source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $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 = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # 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: **owner.id**: *eq* (optional) - # Download violation report + # A list of Saved Searches try { - Get-DefaultViolationReport -ReportResultId $ReportResultId + Get-SavedSearches # Below is a request that includes all optional parameters - # Get-DefaultViolationReport -ReportResultId $ReportResultId + # Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches" Write-Host $_.ErrorDetails } -- path: /sod-violation-report - method: GET +- path: /saved-searches/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status + label: SDK_tools/sdk/powershell/v3/methods/saved-search#put-saved-search 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 + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SavedSearch = @" + { + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] } -- 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 + # Updates an existing saved search try { - Get-SodPolicy -Id $Id + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-SavedSearch -Id $Id -SavedSearch $Result # Below is a request that includes all optional parameters - # Get-SodPolicy -Id $Id + # Send-SavedSearch -Id $Id -SavedSearch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule - method: GET +- path: /scheduled-searches + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#create-scheduled-search source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + $CreateScheduledSearchRequest = @" + {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} + "@ - # Get SOD policy schedule + # Create a new scheduled search try { - Get-SodPolicySchedule -Id $Id + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-ScheduledSearch -CreateScheduledSearchRequest $Result # Below is a request that includes all optional parameters - # Get-SodPolicySchedule -Id $Id + # New-ScheduledSearch -CreateScheduledSearchRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET +- path: /scheduled-searches/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#delete-scheduled-search source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Get violation report run status + # Delete a Scheduled Search try { - Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + Remove-ScheduledSearch -Id $Id # Below is a request that includes all optional parameters - # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + # Remove-ScheduledSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/violation-report +- path: /scheduled-searches/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#get-scheduled-search source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Get SOD violation report status + # Get a Scheduled Search try { - Get-SodViolationReportStatus -Id $Id + Get-ScheduledSearch -Id $Id # Below is a request that includes all optional parameters - # Get-SodViolationReportStatus -Id $Id + # Get-ScheduledSearch -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies +- path: /scheduled-searches method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#list-scheduled-search 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) + $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 = "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) + $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # 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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - # List SOD policies + # List scheduled searches try { - Get-SodPolicies + Get-ScheduledSearch # Below is a request that includes all optional parameters - # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + # Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: PATCH +- path: /scheduled-searches/{id}/unsubscribe + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#unsubscribe-scheduled-search source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $TypedReference = @" + { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + "@ - # Patch SOD policy by ID + # Unsubscribe a recipient from Scheduled Search try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SodPolicy -Id $Id -JsonPatchOperation $Result + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result # Below is a request that includes all optional parameters - # Update-SodPolicy -Id $Id -JsonPatchOperation $Result + # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id}/schedule +- path: /scheduled-searches/{id} method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule + label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#update-scheduled-search source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScheduledSearch = @" { + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, "schedule" : { "hours" : { "values" : [ "MON", "WED" ], @@ -6455,591 +6456,337 @@ "expiration" : "2018-06-25T20:22:28.104Z", "type" : "WEEKLY" }, - "created" : "2020-01-01T00:00:00Z", "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", + "id" : "2c9180867624cbd7017642d8c8c81f67", "type" : "IDENTITY" }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", + "id" : "2c9180867624cbd7017642d8c8c81f67", "type" : "IDENTITY" } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", "emailEmptyResults" : false } "@ - # Update SOD Policy schedule + # Update an existing Scheduled Search try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-ScheduledSearch -Id $Id -ScheduledSearch $Result # Below is a request that includes all optional parameters - # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + # Update-ScheduledSearch -Id $Id -ScheduledSearch $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" Write-Host $_.ErrorDetails } -- path: /sod-policies/{id} - method: PUT +- path: /search/aggregate + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy + label: SDK_tools/sdk/powershell/v3/methods/search#search-aggregate source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" + $Search = @" { - "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" - } ] + "queryDsl" : { + "match" : { + "name" : "john.doe" } }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } }, - "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 $Result - } 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 $Result - } 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 $Result - } 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 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" - Write-Host $_.ErrorDetails - } -- path: /saved-searches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#create-saved-search - source: | - $CreateSavedSearchRequest = @" - - "@ - - # Create a saved search - - try { - $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest - New-SavedSearch -CreateSavedSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-SavedSearch -CreateSavedSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#delete-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete document by ID - - try { - Remove-SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id}/execute - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#execute-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SearchArguments = @" - { - "owner" : "", - "recipients" : [ { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" - } - "@ - - # Execute a saved search by ID - - try { - $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments - Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result - - # Below is a request that includes all optional parameters - # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#get-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Return saved search by ID - - try { - Get-SavedSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-SavedSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch" - Write-Host $_.ErrorDetails - } -- path: /saved-searches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#list-saved-searches - 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 = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # 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: **owner.id**: *eq* (optional) - - # A list of Saved Searches - - try { - Get-SavedSearches - - # Below is a request that includes all optional parameters - # Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches" - Write-Host $_.ErrorDetails - } -- path: /saved-searches/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/saved-search#put-saved-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $SavedSearch = @" - { - "owner" : { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] }, - "created" : "2018-06-25T20:22:28.104Z", - "columns" : { - "identity" : [ { - "field" : "displayName", - "header" : "Display Name" - }, { - "field" : "e-mail", - "header" : "Work Email" - } ] + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 }, - "query" : "@accounts(disabled:true)", - "description" : "Disabled accounts", - "orderBy" : { - "identity" : [ "lastName", "firstName" ], - "role" : [ "name" ] + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] }, - "sort" : [ "displayName" ], - "filters" : { - "terms" : [ "account_count", "account_count" ], - "range" : { - "lower" : { - "inclusive" : false, - "value" : "1" + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } }, - "upper" : { - "inclusive" : false, - "value" : "1" + "nested" : { + "name" : "id", + "type" : "access" } }, - "exclude" : false, - "type" : "RANGE" - }, - "ownerId" : "2c91808568c529c60168cca6f90c1313", - "indices" : [ "identities" ], - "public" : false, - "name" : "Disabled accounts", - "modified" : "2018-06-25T20:22:28.104Z", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "fields" : [ "disabled" ] - } - "@ - - # Updates an existing saved search - - try { - $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch - Send-SavedSearch -Id $Id -SavedSearch $Result - - # Below is a request that includes all optional parameters - # Send-SavedSearch -Id $Id -SavedSearch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" - Write-Host $_.ErrorDetails + "nested" : { + "name" : "id", + "type" : "access" + } + } } -- path: /scheduled-searches - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#create-scheduled-search - source: | - $CreateScheduledSearchRequest = @" - {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} "@ - - # Create a new scheduled search - - try { - $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest - New-ScheduledSearch -CreateScheduledSearchRequest $Result - - # Below is a request that includes all optional parameters - # New-ScheduledSearch -CreateScheduledSearchRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#delete-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Delete a Scheduled Search - - try { - Remove-ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#get-scheduled-search - source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - - # Get a Scheduled Search - - try { - Get-ScheduledSearch -Id $Id - - # Below is a request that includes all optional parameters - # Get-ScheduledSearch -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" - Write-Host $_.ErrorDetails - } -- path: /scheduled-searches - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#list-scheduled-search - 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 = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # 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: **owner.id**: *eq* **savedSearchId**: *eq* (optional) - # List scheduled searches + # Perform a Search Query Aggregation try { - Get-ScheduledSearch + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Aggregate -Search $Result # Below is a request that includes all optional parameters - # Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + # Search-Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id}/unsubscribe +- path: /search/count method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#unsubscribe-scheduled-search + label: SDK_tools/sdk/powershell/v3/methods/search#search-count source: | - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $TypedReference = @" + $Search = @" { - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } } "@ - # Unsubscribe a recipient from Scheduled Search + # Count Documents Satisfying a Query try { - $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference - Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Count -Search $Result # Below is a request that includes all optional parameters - # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $Result + # Search-Count -Search $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" Write-Host $_.ErrorDetails } -- path: /scheduled-searches/{id} - method: PUT +- path: /search/{index}/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/scheduled-search#update-scheduled-search + label: SDK_tools/sdk/powershell/v3/methods/search#search-get source: | + $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - $ScheduledSearch = @" - { - "owner" : { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "displayQueryDetails" : false, - "created" : "", - "description" : "Daily disabled accounts", - "ownerId" : "2c9180867624cbd7017642d8c8c81f67", - "enabled" : false, - "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" - }, - "recipients" : [ { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, { - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - } ], - "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", - "name" : "Daily disabled accounts", - "modified" : "", - "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", - "emailEmptyResults" : false - } - "@ - # Update an existing Scheduled Search + # Get a Document by ID try { - $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch - Update-ScheduledSearch -Id $Id -ScheduledSearch $Result + Search-Get -Index $Index -Id $Id # Below is a request that includes all optional parameters - # Update-ScheduledSearch -Id $Id -ScheduledSearch $Result + # Search-Get -Index $Index -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get" Write-Host $_.ErrorDetails } -- path: /search/aggregate +- path: /search method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-aggregate + label: SDK_tools/sdk/powershell/v3/methods/search#search-post source: | $Search = @" { @@ -7159,875 +6906,1086 @@ } } } - "@ - $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) + "@ + $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 = 10000 # 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) + + # Perform Search + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Post -Search $Result + + # Below is a request that includes all optional parameters + # 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 + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-SearchAttributeConfig -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-SearchAttributeConfig -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-SearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Remove-SearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-search-attribute-config + source: | + + # List Extended Search Attributes + + try { + Get-SearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. + + # Get Extended Search Attribute + + try { + Get-SingleSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Get-SingleSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-Segment -Segment $Result + + # Below is a request that includes all optional parameters + # New-Segment -Segment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-Segment -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-Segment -Id $Id + + # Below is a request that includes all optional parameters + # Get-Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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) - # Perform a Search Query Aggregation + # List Segments try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Aggregate -Search $Result + Get-Segments # Below is a request that includes all optional parameters - # Search-Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $Count + # Get-Segments -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments" Write-Host $_.ErrorDetails } -- path: /search/count +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-Segment -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-Segment -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-count + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#create-service-desk-integration source: | - $Search = @" + $ServiceDeskIntegrationDto = @" { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "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" } }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" } "@ - # Count Documents Satisfying a Query + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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-ServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/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 { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Count -Search $Result + Get-ServiceDeskIntegration -Id $Id # Below is a request that includes all optional parameters - # Search-Count -Search $Result + # Get-ServiceDeskIntegration -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /search/{index}/{id} +- path: /service-desk-integrations/templates/{scriptName} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-get + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-template source: | - $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. - $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - # Get a Document by ID + # Service Desk integration template by scriptName try { - Search-Get -Index $Index -Id $Id + Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName # Below is a request that includes all optional parameters - # Search-Get -Index $Index -Id $Id + # Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate" Write-Host $_.ErrorDetails } -- path: /search - method: POST +- path: /service-desk-integrations/types + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search#search-post + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-types source: | - $Search = @" - { - "queryDsl" : { - "match" : { - "name" : "john.doe" - } - }, - "aggregationType" : "DSL", - "aggregationsVersion" : "", - "query" : { - "query" : "name:a*", - "timeZone" : "America/Chicago", - "fields" : "[firstName,lastName,email]", - "innerHit" : { - "query" : "source.name:\\\"Active Directory\\\"", - "type" : "access" - } - }, - "aggregationsDsl" : { }, - "sort" : [ "displayName", "+id" ], - "filters" : { }, - "queryVersion" : "", - "queryType" : "SAILPOINT", - "includeNested" : true, - "queryResultFilter" : { - "excludes" : [ "stacktrace" ], - "includes" : [ "name", "displayName" ] - }, - "indices" : [ "identities" ], - "typeAheadQuery" : { - "field" : "source.name", - "size" : 100, - "query" : "Work", - "sortByValue" : true, - "nestedType" : "access", - "sort" : "asc", - "maxExpansions" : 10 - }, - "textQuery" : { - "contains" : true, - "terms" : [ "The quick brown fox", "3141592", "7" ], - "matchAny" : false, - "fields" : [ "displayName", "employeeNumber", "roleCount" ] - }, - "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], - "aggregations" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "subAggregation" : { - "filter" : { - "field" : "access.type", - "name" : "Entitlements", - "type" : "TERM", - "value" : "ENTITLEMENT" - }, - "bucket" : { - "field" : "attributes.city", - "size" : 100, - "minDocCount" : 2, - "name" : "Identity Locations", - "type" : "TERMS" - }, - "metric" : { - "field" : "@access.name", - "name" : "Access Name Count", - "type" : "COUNT" - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - }, - "nested" : { - "name" : "id", - "type" : "access" - } - } - } - "@ - $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 = 10000 # 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) - # Perform Search + # List Service Desk integration types try { - $Result = ConvertFrom-JsonToSearch -Json $Search - Search-Post -Search $Result + Get-ServiceDeskIntegrationTypes # Below is a request that includes all optional parameters - # Search-Post -Search $Result -Offset $Offset -Limit $Limit -Count $Count + # Get-ServiceDeskIntegrationTypes } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config - method: POST +- path: /service-desk-integrations + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#create-search-attribute-config + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integrations source: | - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ + $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 = "name eq "John Doe"" # 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) - # Create Extended Search Attributes + # List existing Service Desk integrations try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-SearchAttributeConfig -SearchAttributeConfig $Result + Get-ServiceDeskIntegrations # Below is a request that includes all optional parameters - # New-SearchAttributeConfig -SearchAttributeConfig $Result + # Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} - method: DELETE +- path: /service-desk-integrations/status-check-configuration + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#delete-search-attribute-config + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-status-check-details source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - # Delete Extended Search Attribute + # Get the time check configuration try { - Remove-SearchAttributeConfig -Name $Name + Get-StatusCheckDetails # Below is a request that includes all optional parameters - # Remove-SearchAttributeConfig -Name $Name + # Get-StatusCheckDetails } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config - method: GET +- path: /service-desk-integrations/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-search-attribute-config + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#patch-service-desk-integration source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" - # List Extended Search Attributes + "@ + + # Patch a Service Desk Integration try { - Get-SearchAttributeConfig + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result # Below is a request that includes all optional parameters - # Get-SearchAttributeConfig + # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "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", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ - # Get Extended Search Attribute + # Update a Service Desk integration try { - Get-SingleSearchAttributeConfig -Name $Name + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result # Below is a request that includes all optional parameters - # Get-SingleSearchAttributeConfig -Name $Name + # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" Write-Host $_.ErrorDetails } -- path: /accounts/search-attribute-config/{name} - method: PATCH +- path: /service-desk-integrations/status-check-configuration + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/search-attribute-configuration#patch-search-attribute-config + label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#update-status-check-details source: | - $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ - # Update Extended Search Attribute + # Update the time check configuration try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-StatusCheckDetails -QueuedCheckConfigDetails $Result # Below is a request that includes all optional parameters - # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $Result + # Update-StatusCheckDetails -QueuedCheckConfigDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /segments +- path: /sod-policies method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#create-segment + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy source: | - $Segment = @" + $SodPolicy = @" { - "owner" : { - "name" : "support", + "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", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" + "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" } }, - "name" : "segment-xyz", + "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", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + "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 Segment + # Create SOD policy try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-Segment -Segment $Result + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy -SodPolicy $Result # Below is a request that includes all optional parameters - # New-Segment -Segment $Result + # New-SodPolicy -SodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" Write-Host $_.ErrorDetails } -- path: /segments/{id} +- path: /sod-policies/{id} method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#delete-segment + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + $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 Segment by ID + # Delete SOD policy by ID try { - Remove-Segment -Id $Id + Remove-SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Remove-Segment -Id $Id + # Remove-SodPolicy -Id $Id -Logical $Logical } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" Write-Host $_.ErrorDetails } -- path: /segments/{id} - method: GET +- path: /sod-policies/{id}/schedule + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#get-segment + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - # Get Segment by ID + # Delete SOD policy schedule try { - Get-Segment -Id $Id + Remove-SodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Get-Segment -Id $Id + # Remove-SodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" Write-Host $_.ErrorDetails } -- path: /segments +- path: /sod-violation-report/{reportResultId}/download/{fileName} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#list-segments + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report 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) + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. - # List Segments + # Download custom violation report try { - Get-Segments + Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName # Below is a request that includes all optional parameters - # Get-Segments -Limit $Limit -Offset $Offset -Count $Count + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" Write-Host $_.ErrorDetails } -- path: /segments/{id} - method: PATCH +- path: /sod-violation-report/{reportResultId}/download + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/segments#patch-segment + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report 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}}]}}}]"@ - + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - # Update Segment + # Download violation report try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-Segment -Id $Id -RequestBody $Result + Get-DefaultViolationReport -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Update-Segment -Id $Id -RequestBody $Result + # Get-DefaultViolationReport -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations - method: POST +- path: /sod-violation-report + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#create-service-desk-integration + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "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", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" - } - "@ - # Create new Service Desk integration + # Get multi-report run task status try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + Get-SodAllReportRunStatus # Below is a request that includes all optional parameters - # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $Result + # Get-SodAllReportRunStatus } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE + } +- path: /sod-policies/{id} + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#delete-service-desk-integration + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy source: | - $Id = "anId" # String | ID of Service Desk integration to delete + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - # Delete a Service Desk integration + # Get SOD policy by ID try { - Remove-ServiceDeskIntegration -Id $Id + Get-SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Remove-ServiceDeskIntegration -Id $Id + # Get-SodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} +- path: /sod-policies/{id}/schedule method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule source: | - $Id = "anId" # String | ID of the Service Desk integration to get + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - # Get a Service Desk integration + # Get SOD policy schedule try { - Get-ServiceDeskIntegration -Id $Id + Get-SodPolicySchedule -Id $Id # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegration -Id $Id + # Get-SodPolicySchedule -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/templates/{scriptName} +- path: /sod-policies/sod-violation-report-status/{reportResultId} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-template + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - # Service Desk integration template by scriptName + # Get violation report run status try { - Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName + Get-SodViolationReportRunStatus -ReportResultId $ReportResultId # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/types +- path: /sod-policies/{id}/violation-report method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-types + 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. - # List Service Desk integration types + # Get SOD violation report status try { - Get-ServiceDeskIntegrationTypes + Get-SodViolationReportStatus -Id $Id # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegrationTypes + # Get-SodViolationReportStatus -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations +- path: /sod-policies method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integrations + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies 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 = "name eq "John Doe"" # 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) + $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 existing Service Desk integrations + # List SOD policies try { - Get-ServiceDeskIntegrations + Get-SodPolicies # Below is a request that includes all optional parameters - # Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/status-check-configuration - method: GET +- path: /sod-policies/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-status-check-details + 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" + }"@ - # Get the time check configuration + + # Patch SOD policy by ID try { - Get-StatusCheckDetails + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Get-StatusCheckDetails + # Update-SodPolicy -Id $Id -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} - method: PATCH +- path: /sod-policies/{id}/schedule + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#patch-service-desk-integration + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - + $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 + } "@ - # Patch a Service Desk Integration + # Update SOD Policy schedule try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule -Id $Id -SodPolicySchedule $Result # Below is a request that includes all optional parameters - # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/{id} +- path: /sod-policies/{id} method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#put-service-desk-integration + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" { - "ownerRef" : "", - "cluster" : "xyzzy999", - "created" : "2024-01-17T18:45:25.994Z", - "description" : "A very nice Service Desk integration", - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "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" + "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" + } ] } }, - "name" : "Service Desk Integration Name", - "modified" : "2024-02-18T18:45:25.994Z", - "attributes" : { - "property" : "value", - "key" : "value" + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" }, - "id" : "62945a496ef440189b1f03e3623411c8", - "beforeProvisioningRule" : "" + "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 a Service Desk integration + # 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 $Result + } 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 { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + Start-EvaluateSodPolicy -Id $Id # Below is a request that includes all optional parameters - # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + # Start-EvaluateSodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" Write-Host $_.ErrorDetails } -- path: /service-desk-integrations/status-check-configuration - method: PUT +- path: /sod-violation-report/run + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#update-status-check-details + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org source: | - $QueuedCheckConfigDetails = @" + $MultiPolicyRequest = @" { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] } "@ - # Update the time check configuration + # Runs all policies for org try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-StatusCheckDetails -QueuedCheckConfigDetails $Result + Start-SodAllPoliciesForOrg # Below is a request that includes all optional parameters - # Update-StatusCheckDetails -QueuedCheckConfigDetails $Result + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sod-policies/{id}/violation-report/run + 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#start-sod-policy source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - # Finds status of source usage + # Runs SOD policy violation report try { - Get-StatusBySourceId -SourceId $SourceId + Start-SodPolicy -Id $Id # Below is a request that includes all optional parameters - # Get-StatusBySourceId -SourceId $SourceId + # Start-SodPolicy -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries - method: GET +- path: /sod-violations/predict + method: POST 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-violations#start-predict-sod-violations 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) + $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" + } ] + } + "@ - # Returns source usage insights + # Predict SOD violations for identity. try { - Get-UsagesBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-PredictSodViolations -IdentityWithNewAccess $Result # Below is a request that includes all optional parameters - # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Start-PredictSodViolations -IdentityWithNewAccess $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + 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 $Result + } 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,679 +9403,679 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/approve/{approvalItemId} +- path: /workflow-executions/{id}/cancel method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item + label: SDK_tools/sdk/powershell/v3/methods/workflows#cancel-workflow-execution source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - # Approve an Approval Item + # Cancel Workflow Execution by ID try { - Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Suspend-WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Suspend-WorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-approve/{id} +- path: /workflows/execute/external/{id} method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-external-execute-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" - # Bulk approve Approval Items + "@ + + # Execute Workflow via External Trigger try { - Approve-ApprovalItemsInBulk -Id $Id + New-ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # Approve-ApprovalItemsInBulk -Id $Id + # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id} +- path: /workflows method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $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')]}}} + "@ - # Complete a Work Item + # Create Workflow try { - Complete-WorkItem -Id $Id + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-Workflow -CreateWorkflowRequest $Result # Below is a request that includes all optional parameters - # Complete-WorkItem -Id $Id + # New-Workflow -CreateWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/completed - method: GET +- path: /workflows/{id}/external/oauth-clients + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow-external-trigger 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) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Completed Work Items + # Generate External Trigger OAuth Client try { - Get-CompletedWorkItems + New-WorkflowExternalTrigger -Id $Id # Below is a request that includes all optional parameters - # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + # New-WorkflowExternalTrigger -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" Write-Host $_.ErrorDetails } -- path: /work-items/completed/count - method: GET +- path: /workflows/{id} + method: DELETE xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-work-items + label: SDK_tools/sdk/powershell/v3/methods/workflows#delete-workflow source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - # Count Completed Work Items + # Delete Workflow By Id try { - Get-CountCompletedWorkItems + Remove-Workflow -Id $Id # Below is a request that includes all optional parameters - # Get-CountCompletedWorkItems -OwnerId $OwnerId + # Remove-Workflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/count +- path: /workflows/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-work-items + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow source: | - $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Count Work Items + # Get Workflow By Id try { - Get-CountWorkItems + Get-Workflow -Id $Id # Below is a request that includes all optional parameters - # Get-CountWorkItems -OwnerId $OwnerId + # Get-Workflow -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" Write-Host $_.ErrorDetails } -- path: /work-items/{id} +- path: /workflow-executions/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution source: | - $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - # Get a Work Item + # Get Workflow Execution try { - Get-WorkItem -Id $Id + Get-WorkflowExecution -Id $Id # Below is a request that includes all optional parameters - # Get-WorkItem -Id $Id + # Get-WorkflowExecution -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" Write-Host $_.ErrorDetails } -- path: /work-items/summary +- path: /workflow-executions/{id}/history method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution-history source: | - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - # Work Items Summary + # Get Workflow Execution History try { - Get-WorkItemsSummary + Get-WorkflowExecutionHistory -Id $Id # Below is a request that includes all optional parameters - # Get-WorkItemsSummary -OwnerId $OwnerId + # Get-WorkflowExecutionHistory -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" Write-Host $_.ErrorDetails } -- path: /work-items +- path: /workflows/{id}/executions method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#list-work-items + label: SDK_tools/sdk/powershell/v3/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) - $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + $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 Work Items + # List Workflow Executions try { - Get-WorkItems + Get-WorkflowExecutions -Id $Id # Below is a request that includes all optional parameters - # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + # Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/reject/{approvalItemId} - method: POST +- path: /workflow-library + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-complete-workflow-library source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + $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) - # Reject an Approval Item + # List Complete Workflow Library try { - Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + Get-CompleteWorkflowLibrary # Below is a request that includes all optional parameters - # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" Write-Host $_.ErrorDetails } -- path: /work-items/bulk-reject/{id} - method: POST +- path: /workflow-library/actions + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-actions source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $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) - # Bulk reject Approval Items + # List Workflow Library Actions try { - Deny-ApprovalItemsInBulk -Id $Id + Get-WorkflowLibraryActions # Below is a request that includes all optional parameters - # Deny-ApprovalItemsInBulk -Id $Id + # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/forward - method: POST +- path: /workflow-library/operators + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-operators 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 + # List Workflow Library Operators try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Send-WorkItemForward -Id $Id -WorkItemForward $Result + Get-WorkflowLibraryOperators # Below is a request that includes all optional parameters - # Send-WorkItemForward -Id $Id -WorkItemForward $Result + # Get-WorkflowLibraryOperators } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" Write-Host $_.ErrorDetails } -- path: /work-items/{id}/submit-account-selection - method: POST +- path: /workflow-library/triggers + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-triggers source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + $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) - # Submit Account Selections + # List Workflow Library Triggers try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-AccountSelection -Id $Id -RequestBody $Result + Get-WorkflowLibraryTriggers # Below is a request that includes all optional parameters - # Submit-AccountSelection -Id $Id -RequestBody $Result + # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST +- path: /workflows + method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#cancel-workflow-execution + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflows source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - # Cancel Workflow Execution by ID + # List Workflows try { - Suspend-WorkflowExecution -Id $Id + Get-Workflows # Below is a request that includes all optional parameters - # Suspend-WorkflowExecution -Id $Id + # Get-Workflows } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id} - method: POST +- path: /workflows/{id} + method: PATCH xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-external-execute-workflow + label: SDK_tools/sdk/powershell/v3/methods/workflows#patch-workflow source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - "@ - # Execute Workflow via External Trigger + # Patch Workflow try { - New-ExternalExecuteWorkflow -Id $Id + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Workflow -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + # Update-Workflow -Id $Id -JsonPatchOperation $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" Write-Host $_.ErrorDetails } -- path: /workflows - method: POST +- path: /workflows/{id} + method: PUT xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow + label: SDK_tools/sdk/powershell/v3/methods/workflows#put-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')]}}} + $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 + } "@ - # Create Workflow + # Update Workflow try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-Workflow -CreateWorkflowRequest $Result + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-Workflow -Id $Id -WorkflowBody $Result # Below is a request that includes all optional parameters - # New-Workflow -CreateWorkflowRequest $Result + # Send-Workflow -Id $Id -WorkflowBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/external/oauth-clients +- path: /workflows/execute/external/{id}/test method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow-external-trigger + label: SDK_tools/sdk/powershell/v3/methods/workflows#test-external-execute-workflow source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" - # Generate External Trigger OAuth Client + "@ + + # Test Workflow via External Trigger try { - New-WorkflowExternalTrigger -Id $Id + Test-ExternalExecuteWorkflow -Id $Id # Below is a request that includes all optional parameters - # New-WorkflowExternalTrigger -Id $Id + # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: DELETE +- path: /workflows/{id}/test + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#delete-workflow + label: SDK_tools/sdk/powershell/v3/methods/workflows#test-workflow source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $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}]}} + "@ - # Delete Workflow By Id + # Test Workflow By Id try { - Remove-Workflow -Id $Id + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-Workflow -Id $Id -TestWorkflowRequest $Result # Below is a request that includes all optional parameters - # Remove-Workflow -Id $Id + # Test-Workflow -Id $Id -TestWorkflowRequest $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: GET +- path: /work-items/{id}/approve/{approvalItemId} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Get Workflow By Id + # Approve an Approval Item try { - Get-Workflow -Id $Id + Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Get-Workflow -Id $Id + # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id} - method: GET +- path: /work-items/bulk-approve/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution + label: SDK_tools/sdk/powershell/v3/methods/work-items#approve-approval-items-in-bulk source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Get Workflow Execution + # Bulk approve Approval Items try { - Get-WorkflowExecution -Id $Id + Approve-ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Get-WorkflowExecution -Id $Id + # Approve-ApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/history - method: GET +- path: /work-items/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution-history + label: SDK_tools/sdk/powershell/v3/methods/work-items#complete-work-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Get Workflow Execution History + # Complete a Work Item try { - Get-WorkflowExecutionHistory -Id $Id + Complete-WorkItem -Id $Id # Below is a request that includes all optional parameters - # Get-WorkflowExecutionHistory -Id $Id + # Complete-WorkItem -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/executions +- path: /work-items/completed method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-executions + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-completed-work-items source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $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) - $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 + # Completed Work Items try { - Get-WorkflowExecutions -Id $Id + Get-CompletedWorkItems # Below is a request that includes all optional parameters - # Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflow-library +- path: /work-items/completed/count method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-complete-workflow-library + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-completed-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) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # List Complete Workflow Library + # Count Completed Work Items try { - Get-CompleteWorkflowLibrary + Get-CountCompletedWorkItems # Below is a request that includes all optional parameters - # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + # Get-CountCompletedWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" Write-Host $_.ErrorDetails } -- path: /workflow-library/actions +- path: /work-items/count method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-actions + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-count-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) - $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) + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - # List Workflow Library Actions + # Count Work Items try { - Get-WorkflowLibraryActions + Get-CountWorkItems # Below is a request that includes all optional parameters - # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + # Get-CountWorkItems -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" Write-Host $_.ErrorDetails } -- path: /workflow-library/operators +- path: /work-items/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-operators + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-item source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - # List Workflow Library Operators + # Get a Work Item try { - Get-WorkflowLibraryOperators + Get-WorkItem -Id $Id # Below is a request that includes all optional parameters - # Get-WorkflowLibraryOperators + # Get-WorkItem -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" Write-Host $_.ErrorDetails } -- path: /workflow-library/triggers +- path: /work-items/summary method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-triggers + label: SDK_tools/sdk/powershell/v3/methods/work-items#get-work-items-summary 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) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # List Workflow Library Triggers + # Work Items Summary try { - Get-WorkflowLibraryTriggers + Get-WorkItemsSummary # Below is a request that includes all optional parameters - # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + # Get-WorkItemsSummary -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" Write-Host $_.ErrorDetails } -- path: /workflows +- path: /work-items method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflows + 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 Workflows + # List Work Items try { - Get-Workflows + Get-WorkItems # Below is a request that includes all optional parameters - # Get-Workflows + # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: PATCH +- path: /work-items/{id}/reject/{approvalItemId} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#patch-workflow + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-item source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Patch Workflow + # Reject an Approval Item try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Workflow -Id $Id -JsonPatchOperation $Result + Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId # Below is a request that includes all optional parameters - # Update-Workflow -Id $Id -JsonPatchOperation $Result + # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" Write-Host $_.ErrorDetails } -- path: /workflows/{id} - method: PUT +- path: /work-items/bulk-reject/{id} + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#put-workflow + label: SDK_tools/sdk/powershell/v3/methods/work-items#reject-approval-items-in-bulk 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 - } - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Update Workflow + # Bulk reject Approval Items try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-Workflow -Id $Id -WorkflowBody $Result + Deny-ApprovalItemsInBulk -Id $Id # Below is a request that includes all optional parameters - # Send-Workflow -Id $Id -WorkflowBody $Result + # Deny-ApprovalItemsInBulk -Id $Id } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" Write-Host $_.ErrorDetails } -- path: /workflows/execute/external/{id}/test +- path: /work-items/{id}/forward method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#test-external-execute-workflow + label: SDK_tools/sdk/powershell/v3/methods/work-items#send-work-item-forward source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } "@ - # Test Workflow via External Trigger + # Forward a Work Item try { - Test-ExternalExecuteWorkflow -Id $Id + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-WorkItemForward -Id $Id -WorkItemForward $Result # Below is a request that includes all optional parameters - # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + # Send-WorkItemForward -Id $Id -WorkItemForward $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" Write-Host $_.ErrorDetails } -- path: /workflows/{id}/test +- path: /work-items/{id}/submit-account-selection method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#test-workflow + label: SDK_tools/sdk/powershell/v3/methods/work-items#submit-account-selection 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}]}} - "@ + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName - # Test Workflow By Id + # Submit Account Selections try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-Workflow -Id $Id -TestWorkflowRequest $Result + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-AccountSelection -Id $Id -RequestBody $Result # Below is a request that includes all optional parameters - # Test-Workflow -Id $Id -TestWorkflowRequest $Result + # Submit-AccountSelection -Id $Id -RequestBody $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" Write-Host $_.ErrorDetails }